https://github.com/wordpress-mobile/release-toolkit

Shared tools used in release automation
https://github.com/wordpress-mobile/release-toolkit

Last synced: about 1 month ago
JSON representation

Shared tools used in release automation

• Host: GitHub
• URL: https://github.com/wordpress-mobile/release-toolkit
• Owner: wordpress-mobile
• License: gpl-2.0
• Created: 2018-07-10T08:52:02.000Z (about 6 years ago)
• Default Branch: trunk
• Last Pushed: 2024-04-12T14:29:08.000Z (5 months ago)
• Last Synced: 2024-04-14T11:22:39.052Z (5 months ago)
• Language: Ruby
• Size: 100 MB
• Stars: 31
• Watchers: 22
• Forks: 9
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# release-toolkit

Release-toolkit is a collection of [Fastlane](https://fastlane.tools/) actions used to automate some of the steps of the WordPress release process.  

## Integrating the Library 

To install the library, simply add the following lines to your Fastlane Pluginfile:

```bash

gem 'fastlane-plugin-wpmreleasetoolkit', git: 'https://github.com/wordpress-mobile/release-toolkit', tag: '0.6.0' # or the version number you want

```

## Usage

You can use the actions in the library as common Fastlane actions. 

More details about the actions can be found [here](lib/fastlane/plugin/wpmreleasetoolkit/actions/).

## Contributing

Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues, contributing code, and more ways to contribute.

This guide also includes some tips about configuring your environment and IDE (e.g. VSCode) and how to run tests and documentation.

## Doing a new Release

When you need to do a new release of the `release-toolkit`, simply run `rake new_release` and follow the instructions.

> This task will:

>  - Show you the CHANGELOG/release notes it's about to use for that version

>  - Deduce which version number to use according to [SemVer](https://semver.org/) rules, and ask you to confirm that version number

>  - Create a `release/` branch, update the version number in all the right places, and create a PR for those changes

Submit the PR, adding the `Releases` label to it and adding the `owl-team` as reviewers.

Once that PR is approved and merged, create a new GitHub Release, copy/pasting the CHANGELOG entries for that GH release's description.

> Publishing the GitHub Release will create the associated tag as well, which will trigger the CI job that will ultimately `gem push` the gem on RubyGems.

## Security

If you happen to find a security vulnerability, we would appreciate you letting us know at https://hackerone.com/automattic and allowing us to respond before disclosing the issue publicly.

## Getting in Touch ##

If you have questions about getting setup or just want to say hi, join the [WordPress Slack](https://chat.wordpress.org) and drop a message on the `#mobile` channel.

## Resources

- [WordPress Mobile Blog](http://make.wordpress.org/mobile)

- [WordPress Mobile Handbook](http://make.wordpress.org/mobile/handbook/)

## License

Mobile Release Toolkit is an Open Source project covered by the [GNU General Public License version 2](LICENSE).