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.

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

Github actions workflow to automate tasks when a Caliper release is tagged #1641

Open
davidkel opened this issue Oct 17, 2024 · 2 comments
Open
Labels
build enhancement New feature or request publish/docker Related to Docker image publishing publish/npm Related to NPM package publishing

Comments

@davidkel
Copy link
Contributor

Things like

  • publish a version of the docs for that tag
  • publish official docker images and npm modules
  • bump the code to the next unstable version

Basically anything listed in the Release_process.md file which could be automated

Note Mike (used by the docs) cannot do anything with github to automatically update the docs (even if we change the branch to not require PRs have a ruleset the locks down the branch) as it uses the git command and the actions token is only authorised for Rest api calls.

There is a solution to this via the official github actions that can update gh-pages in conjunction with mike creating the content locally. Would require checking out gh-pages and generating the content via mike on that gh-pages version.

@davidkel davidkel added enhancement New feature or request publish/npm Related to NPM package publishing publish/docker Related to Docker image publishing build labels Oct 17, 2024
@Veer0x1
Copy link
Contributor

Veer0x1 commented Dec 29, 2024

We can follow the semantic versioning, and use a release-v* type of branch. If this looks fine to you then I can proceed with adding github action to automatically update the docker image, npm package, attaching the version tags, and updating documentation.

@davidkel
Copy link
Contributor Author

davidkel commented Jan 7, 2025

@Veer0x1 Would be great if you could do some work on this. However it is quite a substantial piece of work and before working on it I think we need to detail what needs to be tackled and how it will be tackled. The way we currently do documentation releases is geared around the fact we have branch protection requiring PRs on the gh-pages branch. We would need to change the branch protection there and then move to using the official github actions mechanism for deploying to gh-pages. It needs to ensure as well that it preserves what is already there (as we have to make sure an icon can be downloaded by the report generator).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build enhancement New feature or request publish/docker Related to Docker image publishing publish/npm Related to NPM package publishing
Projects
None yet
Development

No branches or pull requests

2 participants