From 677a4960bf36942a04442535179f6ef179c3c936 Mon Sep 17 00:00:00 2001 From: Oksana Salyk Date: Tue, 14 May 2024 07:56:29 +0200 Subject: [PATCH] common: remove pmem.io workflow file and related --- .github/workflows/pmem.io_doc_update.yml | 27 ------- INSTALL.md | 2 +- README.md | 1 - RELEASE_STEPS.md | 3 - utils/build-dpkg.sh | 2 +- utils/libpmem.pc.in | 2 +- utils/libpmem2.pc.in | 2 +- utils/libpmemobj.pc.in | 2 +- utils/libpmempool.pc.in | 2 +- utils/pkg-config.sh | 4 +- utils/pmdk.spec.in | 2 +- utils/run-doc-update.sh | 97 ------------------------ 12 files changed, 9 insertions(+), 137 deletions(-) delete mode 100644 .github/workflows/pmem.io_doc_update.yml delete mode 100755 utils/run-doc-update.sh diff --git a/.github/workflows/pmem.io_doc_update.yml b/.github/workflows/pmem.io_doc_update.yml deleted file mode 100644 index 147bfabd3f2..00000000000 --- a/.github/workflows/pmem.io_doc_update.yml +++ /dev/null @@ -1,27 +0,0 @@ -# Update the PMDK documentation on pmem.io -name: pmem.io - -on: - workflow_dispatch: - push: - paths: - - 'doc/**' - -jobs: - doc_update: - if: github.ref_name == 'master' || startsWith(github.ref_name, 'stable-') - name: doc update - runs-on: ubuntu-latest - steps: - - name: Clone the git repo - uses: actions/checkout@v4 - - - name: Install dependencies - run: sudo apt-get install libndctl-dev libdaxctl-dev pandoc - - - name: Auto doc update - env: - DOC_UPDATE_GITHUB_TOKEN: ${{ secrets.DOC_UPDATE_GITHUB_TOKEN }} - TARGET_BRANCH: ${{ github.ref_name }} - WORKDIR: . - run: utils/run-doc-update.sh diff --git a/INSTALL.md b/INSTALL.md index 4add4622aa8..678f8e7d097 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -128,7 +128,7 @@ To enable logging of debug information, use debug version of a library and set desired log level using (library-specific) variable, e.g. `PMEM_LOG_LEVEL=`. For more details see appropriate manpage (debbuging section), e.g. -[libpmem(7)](https://pmem.io/pmdk/manpages/linux/master/libpmem/libpmem.7/#debugging-and-error-handling). +[libpmem(7)](https://github.com/pmem/pmdk/blob/master/doc/libpmem/libpmem.7.md#error-handling-1). ## Experimental Packages diff --git a/README.md b/README.md index 913b83c21dd..a2753c0d7e5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ [![Coverage](https://codecov.io/github/pmem/pmdk/coverage.svg?branch=master)](https://codecov.io/gh/pmem/pmdk/branch/master) [![PMem test](https://github.com/pmem/pmdk/actions/workflows/pmem_tests.yml/badge.svg?branch=master)](https://github.com/pmem/pmdk/actions/workflows/pmem_tests.yml) [![Pmem RAS](https://github.com/pmem/pmdk/actions/workflows/pmem_ras.yml/badge.svg?branch=master)](https://github.com/pmem/pmdk/actions/workflows/pmem_ras.yml) -[![pmem.io](https://github.com/pmem/pmdk/actions/workflows/pmem.io_doc_update.yml/badge.svg?branch=master)](https://github.com/pmem/pmdk/actions/workflows/pmem.io_doc_update.yml) [![Docker rebuild](https://github.com/pmem/pmdk/actions/workflows/docker_rebuild.yml/badge.svg?branch=master)](https://github.com/pmem/pmdk/actions/workflows/docker_rebuild.yml) The **Persistent Memory Development Kit (PMDK)** is a collection of libraries and tools for System Administrators and Application Developers to simplify managing and accessing persistent memory devices. For more information, see https://pmem.io. diff --git a/RELEASE_STEPS.md b/RELEASE_STEPS.md index b7f65147a81..581fa310a4e 100644 --- a/RELEASE_STEPS.md +++ b/RELEASE_STEPS.md @@ -108,15 +108,12 @@ git commit --reset-author ## 6. Announcement (only major/minor releases) Announce the release on the: -- [pmem.io](https://pmem.io/announcements/) - [Slack](https://pmem-io.slack.com) - [Google group](https://groups.google.com/g/pmem ) ## 7. Later, for major/minor release - on the stable-$VER branch, bump the version of Docker images (`utils/docker/images/set-images-version.sh`) to $VER -- once the pmem.github.io repository contains new documentation (thanks to `utils/docker/run-doc-update.sh` script run in CI), - add a new tag ("$VER") in file `data/releases_linux.yml` based on previous tags in this file. ## 8. For curious readers diff --git a/utils/build-dpkg.sh b/utils/build-dpkg.sh index 00304c4154f..30373e46608 100755 --- a/utils/build-dpkg.sh +++ b/utils/build-dpkg.sh @@ -292,7 +292,7 @@ Section: libs Priority: optional Standards-version: 4.1.4 Build-Depends: debhelper (>= 9) -Homepage: https://pmem.io/pmdk/ +Homepage: https://github.com/pmem/pmdk Package: libpmem Architecture: any diff --git a/utils/libpmem.pc.in b/utils/libpmem.pc.in index 850b2819802..a491b8b3048 100644 --- a/utils/libpmem.pc.in +++ b/utils/libpmem.pc.in @@ -3,7 +3,7 @@ includedir=${prefix}/include Name: libpmem Description: libpmem library from PMDK project Version: ${version} -URL: https://pmem.io/pmdk +URL: https://github.com/pmem/pmdk Requires: Libs: -L${libdir} -lpmem Cflags: -I${includedir} diff --git a/utils/libpmem2.pc.in b/utils/libpmem2.pc.in index d4ddc907cf8..9ff9b48f1dd 100644 --- a/utils/libpmem2.pc.in +++ b/utils/libpmem2.pc.in @@ -3,7 +3,7 @@ includedir=${prefix}/include Name: libpmem2 Description: libpmem2 library from PMDK project Version: ${version} -URL: https://pmem.io/pmdk +URL: https://github.com/pmem/pmdk Requires: Libs: -L${libdir} -lpmem2 Cflags: -I${includedir} diff --git a/utils/libpmemobj.pc.in b/utils/libpmemobj.pc.in index 12c396e9e7c..62fe3feaa1a 100644 --- a/utils/libpmemobj.pc.in +++ b/utils/libpmemobj.pc.in @@ -3,7 +3,7 @@ includedir=${prefix}/include Name: libpmemobj Description: libpmemobj library from PMDK project Version: ${version} -URL: https://pmem.io/pmdk +URL: https://github.com/pmem/pmdk Requires.private: libpmem${rasdeps} Libs: -L${libdir} -lpmemobj Libs.private: -ldl diff --git a/utils/libpmempool.pc.in b/utils/libpmempool.pc.in index 660938a27a0..85f37e56b9f 100644 --- a/utils/libpmempool.pc.in +++ b/utils/libpmempool.pc.in @@ -3,7 +3,7 @@ includedir=${prefix}/include Name: libpmempool Description: libpmempool library from PMDK project Version: ${version} -URL: https://pmem.io/pmdk +URL: https://github.com/pmem/pmdk Requires.private: libpmem${rasdeps} Libs: -L${libdir} -lpmempool Libs.private: -ldl diff --git a/utils/pkg-config.sh b/utils/pkg-config.sh index 7186fa2eea6..405fc8a47ff 100644 --- a/utils/pkg-config.sh +++ b/utils/pkg-config.sh @@ -1,5 +1,5 @@ # SPDX-License-Identifier: BSD-3-Clause -# Copyright 2014-2020, Intel Corporation +# Copyright 2014-2024, Intel Corporation # Name of package PACKAGE_NAME="pmdk" @@ -14,4 +14,4 @@ PACKAGE_SUMMARY="Persistent Memory Development Kit" PACKAGE_DESCRIPTION="The collection of libraries and utilities for Persistent Memory Programming" # Website -PACKAGE_URL="https://pmem.io/pmdk" +PACKAGE_URL="https://github.com/pmem/pmdk" diff --git a/utils/pmdk.spec.in b/utils/pmdk.spec.in index 0615370f71d..6faf21a7c96 100644 --- a/utils/pmdk.spec.in +++ b/utils/pmdk.spec.in @@ -25,7 +25,7 @@ Summary: __PACKAGE_SUMMARY__ Packager: __PACKAGE_MAINTAINER__ Group: __GROUP_SYS_LIBS__ License: __LICENSE__ -URL: https://pmem.io/pmdk +URL: https://github.com/pmem/pmdk Source0: %{name}-%{version}.tar.gz diff --git a/utils/run-doc-update.sh b/utils/run-doc-update.sh deleted file mode 100755 index 52e6fd32499..00000000000 --- a/utils/run-doc-update.sh +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env bash -# SPDX-License-Identifier: BSD-3-Clause -# Copyright 2019-2023, Intel Corporation - -# -# run-doc-update.sh - builds docs and creates a pull request with an update to -# the pmem.github.io repository. The only supported branches are master -# and stable-*. -# -set -e - -if [[ -z "${DOC_UPDATE_GITHUB_TOKEN}" ]]; then - echo "ERROR: To build documentation and upload it as a Github pull request, " \ - "variable 'DOC_UPDATE_GITHUB_TOKEN' has to be provided." - exit 1 -fi - -if [[ -z "${WORKDIR}" ]]; then - echo "ERROR: The variable WORKDIR has to contain a path to the root " \ - "of this project." - exit 1 -fi - -BOT_NAME="pmem-bot" -USER_NAME="pmem" -PAGES_REPO_NAME="pmem.github.io" - -DOC_REPO_DIR=$(mktemp -d -t pmem_io-XXX) -ARTIFACTS_DIR=$(mktemp -d -t ARTIFACTS-XXX) - -ORIGIN="https://${DOC_UPDATE_GITHUB_TOKEN}@github.com/${BOT_NAME}/${PAGES_REPO_NAME}" -UPSTREAM="https://github.com/${USER_NAME}/${PAGES_REPO_NAME}" - -# Determine docs location dir on gh-pages branch -case $TARGET_BRANCH in -master) - TARGET_DOCS_DIR="master" - ;; -stable-*) - TARGET_DOCS_DIR=v$(echo ${TARGET_BRANCH} | cut -d"-" -f2 -s) - ;; -*) - echo "ERROR: This script should be run only on master or stable-* branches." - echo "TARGET_BRANCH is set to: \'${TARGET_BRANCH}\'." - exit 1 -esac - -pushd ${WORKDIR}/doc -echo "Build docs and copy man & web md" -make -j$(nproc) web - -mv ./web_linux ${ARTIFACTS_DIR} -mv ./generated/libs_map.yml ${ARTIFACTS_DIR} -popd - -echo "Clone bot's pmem.io repo" -git clone --depth=1 ${ORIGIN} ${DOC_REPO_DIR} -pushd ${DOC_REPO_DIR} -git remote add upstream ${UPSTREAM} -git fetch upstream - -git config --local user.name ${BOT_NAME} -git config --local user.email "${BOT_NAME}@intel.com" -hub config --global hub.protocol https - -echo "Checkout new branch (based on 'main') for PR" -DOCS_BRANCH_NAME="pmdk-${TARGET_DOCS_DIR}-docs-update" -git checkout -B ${DOCS_BRANCH_NAME} upstream/main -git clean -dfx - -echo "Copy content" -rsync -a ${ARTIFACTS_DIR}/web_linux/ ./content/pmdk/manpages/linux/${TARGET_DOCS_DIR}/ --delete - -if [ ${TARGET_BRANCH} = "master" ]; then - cp ${ARTIFACTS_DIR}/libs_map.yml data/ -fi - -echo "Add and push changes" -# git commit command may fail if there is nothing to commit. -# In that case we want to force push anyway (there might be open pull request -# with changes which were reverted). -git add -A -git commit -m "pmdk: automatic docs update for '${TARGET_BRANCH}'" && true -git push -f ${ORIGIN} ${DOCS_BRANCH_NAME} - -echo "Make a Pull Request" -# When there is already an open PR or there are no changes an error is thrown, which we ignore. -GITHUB_TOKEN=${DOC_UPDATE_GITHUB_TOKEN} hub pull-request -f \ - -b ${USER_NAME}:main \ - -h ${BOT_NAME}:${DOCS_BRANCH_NAME} \ - -m "pmdk: automatic docs update for '${TARGET_BRANCH}'" && true - -popd -rm -rf ${DOC_REPO_DIR} -rm -rf ${ARTIFACTS_DIR} - -exit 0