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 publication guide #27

Merged
merged 2 commits into from
Feb 15, 2024
Merged

Update publication guide #27

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9b3dee
update publication guide
imanushin Feb 14, 2024
3d613d6
Merge branch 'master' into updateRelease
imanushin Feb 15, 2024
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
22 changes: 13 additions & 9 deletions .github/PUBLISHING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Gradle plugin publication
# New version publication

This page describes Gradle Plugin publication to [Gradle Plugin Portal](https://plugins.gradle.org/).
This page describes how to publish a new version of plugin and all related artifacts.

Steps:

1. Receive API Key and Secret from the portal (please
follow [the documentation](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html)).
2. Navigate to `Actions` and locate
the [publish workflow](./workflows/publish.yaml). GitHub
1. Create a PR with version increment in [gradle.properties](../gradle.properties). Please follow [semver guidelines](https://semver.org/):
1. If there are breaking `.api` files - increment the major version (e.g. from `x.y.z` to `x+1.0.0`)
2. If current version is compatible with previous one and there are some notable changes - please increment the minor one (e.g. from `x.y.z` to `x.y+1.0`)
3. Otherwise - please increment the patch version (e.g. from `x.y.z` to `x.y.z+1`).
2. Receive API Key and Secret from the portal (please
follow [the documentation](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html)) and add them into the project secrets.
3. Run publication workflows:
1. Navigate to [Actions](https://github.com/Citi/gradle-helm-plugin/actions/workflows/) and locate
the [publish workflow](./workflows/publish.yaml) and [publish documentation one](./workflows/publish.yaml). GitHub
documentation: https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow
3. Insert API Key and Secret from the item '1' above.
4. Create PR with version increment in [gradle.properties](../gradle.properties)
5. Release [the version on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github).
2. Run both workflows
4. Release [the version on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github).
Loading