Skip to content

Commit

Permalink
add instuctions on how to use the version bump workflow (#243)
Browse files Browse the repository at this point in the history
Signed-off-by: Kashish Mittal <[email protected]>
  • Loading branch information
04kash authored Jan 6, 2025
1 parent cda86f1 commit d3f5940
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,10 @@ The `redhat-developer/rhdh-plugins` repository is designed as a collaborative sp
- [Migrating a plugin](#migrating-a-plugin)
- [Manual migration steps](#manual-migration-steps)
- [Using the cli to migrate plugins from janus-idp/backstage-plugins](#using-the-cli-to-migrate-plugins-from-janus-idpbackstage-plugins)
- [Next steps](#next-steps)
- [Maintenance of older versions](#maintenance-of-older-versions)
- [API Reports](#api-reports)
- [Keeping Workspaces Upto Date with Backstage](#keeping-workspaces-upto-date-with-backstage)
- [Submitting a Pull Request](#submitting-a-pull-request)

## License
Expand Down Expand Up @@ -251,6 +254,10 @@ There are two ways you can do this:

Each plugin/package has its own API Report which means you might see more than one file updated or created depending on your changes. These changes will then need to be committed as well.

## Keeping Workspaces Upto Date with Backstage

To keep plugins in the various workspaces up to date with Backstage we have a [Version Bump Workflow](https://github.com/redhat-developer/rhdh-plugins/actions/workflows/version-bump.yml) in place, similar to the one that is used in the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. For instructions on how to use this workflow, refer to the guidelines in this document: https://github.com/backstage/community-plugins/blob/main/docs/version-bump.md#process.

## Submitting a Pull Request

When you've got your contribution working, tested, and committed to your branch it's time to create a Pull Request (PR). If you are unsure how to do this GitHub's [Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) documentation will help you with that.

0 comments on commit d3f5940

Please sign in to comment.