Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update maintenance tasks for refreshing CI tokens #18

Merged
merged 1 commit into from
Sep 10, 2024
Merged

Update maintenance tasks for refreshing CI tokens #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions OpenSC-Release-Howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,6 @@ Optionally, discuss changes to _NEWS_ by opening a [new issue](https://github.co
* In case of security relevant changes, forward the announcement to [[email protected]](https://www.openwall.com/lists/oss-security/)
* Update the [Main Wiki page](https://github.com/OpenSC/OpenSC/wiki) with links to new release

## Clean up old nightly builds repository

* The repository [OpenSC/Nightly](https://github.com/OpenSC/Nightly) is used to hold nightly builds for both MacOS and Windows.
* They are pushed on every master commit so the old builds need to be cleaned up regularly.
* Ideally after the new release is done, any old branch before last release can be removed through the github web UI on [OpenSC/Nightly/branches/stale](https://github.com/OpenSC/Nightly/branches/stale).
* For more info, see the [related issues](https://github.com/OpenSC/Nightly/issues/1)

## Releasing patch versions of OpenSC

* Happens on exceptional basis only when fixing significant problems.
Expand Down Expand Up @@ -179,3 +172,23 @@ Optionally, discuss changes to _NEWS_ by opening a [new issue](https://github.co
6. Wait for [artifacts to build](#build-and-test-binaries)
7. [Create a new release](#build-and-test-binaries)
8. Write [announcement](#announcement)

## Maintenance tasks

### Clean up old nightly builds repository

* The repository [OpenSC/Nightly](https://github.com/OpenSC/Nightly) is used to hold nightly builds for both MacOS and Windows.
* They are pushed on every master commit so the old builds need to be cleaned up regularly.
* Ideally after the new release is done, any old branch before last release can be removed through the github web UI on [OpenSC/Nightly/branches/stale](https://github.com/OpenSC/Nightly/branches/stale).
* For more info, see the [related issues](https://github.com/OpenSC/Nightly/issues/1)

### Refreshing access tokens

There are two access tokens that are used by CI to push artifacts to the Nightly repository. One from Github
Actions and one from AppVeyor. Their expiration can be checked on the
[organization settings](https://github.com/organizations/OpenSC/settings/personal-access-tokens/active) page.

* When they expire, the new need tokens need to be generated in [user settings](https://github.com/settings/tokens?type=beta).
* Both tokens need _Read_ and _Write_ access to code and _Read_ access to metadata in OpenSC/Nightly repository.
* The Github Actions token needs to be inserted into the [OpenSC repository secrets](https://github.com/OpenSC/OpenSC/settings/secrets/actions).
* The AppVeyor token needs to be encrypted using [AppVeyor website](https://ci.appveyor.com/account/frankmorgner/tools/encrypt) and updated in the `.appveyor.yml` for example like done in [#3230](https://github.com/OpenSC/OpenSC/pull/3230).