commit 3d7a44a64273e0e1732095a2faa428c0aa62dab2
parent f10cf54366db4e1551b03a01aa5619b29226ceb1
Author: Andreas Gruhler <agruhl@gmx.ch>
Date: Sun, 12 Dec 2021 10:02:43 +0100
rm actions, workflows and CI docs
Diffstat:
8 files changed, 6 insertions(+), 128 deletions(-)
diff --git a/.github/c/make-install/action.yml b/.github/c/make-install/action.yml
@@ -1,12 +0,0 @@
-runs:
- using: composite
- steps:
- - name: make
- run: make
- shell: bash
- - name: make install
- run: sudo make install
- shell: bash
- - name: check diary version
- run: diary -v
- shell: bash
diff --git a/.github/workflows/c.yml b/.github/workflows/c.yml
@@ -1,29 +0,0 @@
-name: C CI
-
-on:
- push:
- branches: [ master ]
- pull_request:
- branches: [ master ]
-
-jobs:
- macos:
- runs-on: macos-latest
- steps:
- - name: Check out repository
- uses: actions/checkout@v2
- - name: make install
- uses: ./.github/c/make-install
-
- linux:
- runs-on: ${{ matrix.os }}
- strategy:
- matrix:
- os: [ubuntu-18.04, ubuntu-20.04]
- steps:
- - name: Install build requirements
- run: sudo apt-get update && sudo apt-get install libncurses5-dev libncursesw5-dev libcurl4-gnutls-dev
- - name: Check out repository
- uses: actions/checkout@v2
- - name: make install
- uses: ./.github/c/make-install
diff --git a/.github/workflows/man.yml b/.github/workflows/man.yml
@@ -1,23 +0,0 @@
-name: Man page
-
-on:
- push:
- branches: [ master ]
-
-jobs:
- man:
- runs-on: ubuntu-20.04
- steps:
- - name: Check out repository
- uses: actions/checkout@v2
- - name: Install mandoc
- run: sudo apt-get install mandoc
- - name: Create html from man doc
- run: mandoc -Thtml man1/diary.1 > man1/diary.1.html
- - name: Commit new man doc
- run: |
- git config user.name github-actions
- git config user.email github-actions@github.com
- git add man1/diary.1.html
- git diff-index --quiet HEAD || git commit -m "refresh diary manpage"
- git push
diff --git a/.obs/workflows.yml b/.obs/workflows.yml
@@ -1,10 +0,0 @@
-workflow:
- steps:
- - rebuild_package:
- project: home:in0rdr
- package: diary-nightly
- filters:
- event: push
- branches:
- only:
- - master
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,7 @@
* External text format command (#68, #80) --fmt-cmd
* Pseudo-terminal to support ANSI escape characters (colors, font types, etc.) and --no-pty option (#6, #44, #5)
* Mouse support for selecting dates (#60)
-* Documentation for build pipelines (CI/CD) and Open Build Service (OBS) jobs (`docs/CI.md` and `docs/OBS.md`)
+* Documentation of Open Build Service (OBS) jobs (`docs/OBS.md`)
* Documentation of testing and debugging procedures (`docs/TESTING.md`)
* Add `debug` target to `Makefile`
diff --git a/README.md b/README.md
@@ -99,9 +99,6 @@ Note: for *BSD users run gmake.
## OBS Build Documentation
[./docs/OBS.md](./docs/OBS.md)
-## GitHub Action CI Documentation
-[./docs/CI.md](./docs/CI.md)
-
## Test Documentation
[./docs/TESTING.md](./docs/TESTING.md)
diff --git a/docs/CI.md b/docs/CI.md
@@ -1,45 +0,0 @@
-# Documentation of CI Jobs
-
-## OpenSuse Build Service Nightly Builds from Master
-`push` events on the `master` branch trigger a rebuild of the [`diary-nightly`](https://build.opensuse.org/package/show/home:in0rdr/diary-nightly) package in the OpenSuse Build Service (see [./OBS.md](./OBS.md) for a description of the OBS builds).
-
-These jobs are called "workflows" in the OpenSuse Build Service and they are stored at [`.obs/workflows.yml`](../.obs/workflows.yml).
-
-The documentation for this kind of "workflow" can be found in the [GitHub repository of the Open Build Service](https://github.com/openSUSE/open-build-service/wiki/Better-SCM-CI-Integration) and in a [series of blog posts on "SCM integration"](https://openbuildservice.org/blog).
-
-A new chapter in the documentation was written Nov 2021 which explains the purpose and usage of OBS workflows in detail:
-https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.scm_ci_workflow_integration.html
-
-### Create OBS Workflow Token
-
-The `$token` is a 40 char [personal Git access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
-
-A workflow token can be created as follows:
-```bash
-# https://openbuildservice.org/2021/05/31/scm-integration/
-$ osc api -X POST "/person/in0rdr/token?project=home:in0rdr&package=diary-nightly&operation=workflow&scm_token=$token"
-```
-
-To list existing tokens, visit:
-https://build.opensuse.org/my/tokens
-
-Or list via CLI:
-```bash
-$ osc token list
-```
-
-The value of the token is configured on the VCS side.
-
-## GitHub Action to Verify Build
-
-[`.github/workflows/c.yml`](../.github/workflows/c.yml) implements a GitHub action to run the simple series of build steps (`make && make install`) for new commits and pull requests on the `master` branch.
-
-[`.github/c/make-install/action.yml`](../.github/c/make-install/action.yml) is a re-usable action (dependency).
-
-## GitHub Action to Render Man Page
-
-[`.github/workflows/man.yml`](../.github/workflows/man.yml) is a job to render a new version of the man page after each commit or pull request on the `master` branch.
-
-This file is consumed by a Terraform job and rendered at https://diary.in0rdr.ch/man.
-
-A refresh of the html file in this GitHub repository does not automatically refresh the man page on the website (manual step).
diff --git a/docs/OBS.md b/docs/OBS.md
@@ -2,14 +2,14 @@
The OBS project [`home:in0rdr`](https://build.opensuse.org/project/show/home:in0rdr) comprises following `diary` packages:
* `diary`: Latest stable release built from tar.gz statically placed in the source
-* `diary-nightly`: Latest unstable build, re-built dynamically from the code on the GitHub master branch (see [./CI.md](./CI.md) for a description of the GitHub Actions)
+* `diary-nightly`: Latest unstable build, re-built sporadically (manual action) from the code on the master branch
> ℹ️ `diary-nightly` is not branched from `diary`, it has a completely separate build config.
-Additionally, these packages are being used as dependency for `diary-nightly`, to download the latest diary source code from the GitHub master branch:
-* [`openSUSE:Tools/obs-service-tar_scm`](https://github.com/openSUSE/obs-service-tar_scm): Use `obs_scm` to fetch latest GitHub sources
+Additionally, these packages are being used as dependency for `diary-nightly`, to download the latest diary source code from the master branch:
+* [`openSUSE:Tools/obs-service-tar_scm`](https://github.com/openSUSE/obs-service-tar_scm): Use `obs_scm` to fetch latest sources
-* [`openSUSE:Tools/obs-service-recompress`](https://github.com/openSUSE/obs-service-recompress): Re-compress downloaded GitHub source files
+* [`openSUSE:Tools/obs-service-recompress`](https://github.com/openSUSE/obs-service-recompress): Re-compress downloaded source files
* [`openSUSE:Tools/obs-service-set_version`](https://github.com/openSUSE/obs-service-set_version): Set dynamic version based on information (`.obsinfo` file) from the GitHub checkout
## OBS Project Configuration
@@ -103,7 +103,7 @@ This service is used in combination with the service [`tar_scm`](https://github.
### `openSUSE:Tools/obs-service-set_version`
-This service sets the version in the RPM spec or Debian changelog according to the latest source files downloaded from GitHub:
+This service sets the version in the RPM spec or Debian changelog according to the latest downloaded source files:
https://github.com/openSUSE/obs-service-set_version
### `openSUSE:Factory/zstd` OBS Package
