https://github.com/moodlehq/moodle-plugin-release

Template for GitHub Actions YAML file allowing to automatically release tagged version in the Moodle Plugins directory
https://github.com/moodlehq/moodle-plugin-release

Last synced: 14 days ago
JSON representation

Template for GitHub Actions YAML file allowing to automatically release tagged version in the Moodle Plugins directory

• Host: GitHub
• URL: https://github.com/moodlehq/moodle-plugin-release
• Owner: moodlehq
• License: gpl-3.0
• Created: 2021-06-09T10:36:51.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-29T18:48:55.000Z (about 2 years ago)
• Last Synced: 2024-11-11T23:19:56.218Z (2 months ago)
• Size: 24.4 KB
• Stars: 15
• Watchers: 11
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Releasing Moodle plugins in the Plugins directory automatically from GitHub Actions

## Usage

1. Copy the template file [moodle-release.yml](https://github.com/moodlehq/moodle-plugin-release/blob/main/moodle-release.yml)

   into the `.github/workflows/moodle-release.yml` location within your plugin

   repository.

2. Edit the file and set the `PLUGIN` environment variable to the full component name

   (aka frankenstyle) of your plugin. Example:

   ```

    env:

      PLUGIN: mod_subcourse

   ```

   There should be no need to edit any other line as long as you are happy with the

   default behaviour of the workflow.  Please refer to the GitHub Actions

   documentation for details.

3. Log in to the Moodle Plugins directory at . Locate the

   Navigation block > Plugins > API access. Use that page to generate your personal

   token for the `plugins_maintenance` service.

4. Go back to your plugin repository at Github. Locate your plugin's Settings >

   Secrets section. Use the 'New repository secret' button to define a new repository

   secret to hold your access token. Use name `MOODLE_ORG_TOKEN` and set the value to

   the one you generated in previous step.

5. That's it! Now when you tag the repository with a tag that matches the configured

   condition, the tagged version will be released in the plugins directory.

## Tips

* Use settings `$plugin->requires`, `$plugin->supported` and

  `$plugin->incompatible` in your plugin's

  [version.php](https://docs.moodle.org/dev/version.php). They are used to

  automatically populate the list of supported Moodle versions. By default, all Moodle

  versions starting from the one described by `$plugin->requires` will be marked as

  supported.

* Keep the `CHANGES.md` file in the root of your repository. It will be automatically

  imported as release notes for the new version. Please see [Moodle dev

  docs](https://docs.moodle.org/dev/Plugin_files#CHANGES) for all supported names and

  formats.

* If your release tags do not start with `v` character (such as `v9.0.1`) and you want

  to trigger the workflow for any tag, change the condition in the YAML file as:

  ```

  on:

    push:

      tags:

        - '*'

  ```

## License

This program is free software: you can redistribute it and/or modify it under the

terms of the GNU General Public License as published by the Free Software Foundation,

either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY

WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this

program. If not, see .