-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #348 from StatensPensjonskasse/migrate-module-docs
module migration: Fix order of tasks
- Loading branch information
Showing
1 changed file
with
13 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,20 +8,22 @@ summary: Complete directions for migrating a module to Vox Pupuli, including the | |
| You will have someone by your side in this process. The general flow is to… | ||
|
|
||
| * Ask one of the Administrators to add you to the `incoming-migrations` team. | ||
| * At that point you can transfer your own repository. | ||
| * Ensure github issues are enabled. | ||
| * Verify that all webhooks are disabled. | ||
| * If this module was created with PDK delete .sync.yaml. | ||
| * Prepare your repo for transfer | ||
| * If this module was created with PDK delete .sync.yaml. | ||
| * Ensure that the module has a correct `LICENSE` file in the docroot that matches the mentioned license in the `metadata.json`. | ||
| * At this point you can transfer your own repository. | ||
| * Ask an admin to | ||
| * Ensure github issues are enabled. | ||
| * Verify that all webhooks are disabled. | ||
| * Enable `Automatically delete head branches` in the repository settings. | ||
| * Add the `collaborators` team to the module's `Collaborators & Teams` 'Teams' list with `Write` permissions (e.g. [https://github.com/voxpupuli/puppet-gitlab/settings/collaboration](https://github.com/voxpupuli/puppet-gitlab/settings/collaboration) (that link works only for admins). | ||
| * Update the [access permissions](https://github.com/organizations/voxpupuli/settings/secrets/actions) (that link works only for admins) for forge.puppet.com secrets so releases can be published. | ||
| * Add the module to our [modulesync setup][managed_modules]. | ||
| * Enable `Automatically delete head branches` in the repository settings. | ||
| * Ask an admin to add the `collaborators` team to the module's `Collaborators & Teams` 'Teams' list with `Write` permissions (e.g. [https://github.com/voxpupuli/puppet-gitlab/settings/collaboration](https://github.com/voxpupuli/puppet-gitlab/settings/collaboration) (that link works only for admins). | ||
| * The admin shall also update the [access permissions](https://github.com/organizations/voxpupuli/settings/secrets/actions) (that link works only for admins) for forge.puppet.com secrets so releases can be published. | ||
| * Execute [modulesync][msync] for this module. | ||
| * Our modulesync will delete a `CONTRIBUTING.md` in the root directory and place one at `.github/CONTRIBUTING.md`. Please enhance [our existing template][template] if the version in the docroot contains useful parts. | ||
| * [Release][release] the first version under Vox Pupuli. | ||
| * Creata a GitHub issue for the [FORGE][forge] project and ask to deprecate the old module (and approve the new one if the old one was approved as well). | ||
| * Create a Jira issue at [tickets.puppetlabs.com](https://tickets.puppetlabs.com) in the FORGE project and ask to deprecate the old module (and approve the new one if the old one was approved as well). | ||
| * Do you think the module qualifies to be approved? Wait until it is released, then raise a [GitHub Issue][approve] in the Puppetlabs organisation. | ||
| * Our modulesync will delete a `CONTRIBUTING.md` in the root directory and place one at `.github/CONTRIBUTING.md`. Please enhance [our existing template][template] if the version in the docroot contains useful parts. | ||
| * Ensure that the module has a correct `LICENSE` file in the docroot that matches the mentioned license in the `metadata.json`. | ||
| * Write a very short blog post about the migration([example][example]). Write to our [mailinglist](mailto:[email protected]) about the migration/new blogpost. | ||
|
|
||
| If you have many modules you wish to migrate, this will be cumbersome. | ||
|
|
@@ -36,6 +38,7 @@ If the module is accepted, VP will work with you to determine the proper fork/mi | |
|
|
||
| [managed_modules]: https://github.com/voxpupuli/modulesync_config/blob/master/managed_modules.yml | ||
| [msync]: https://github.com/voxpupuli/modulesync_config#modulesync-configs | ||
| [release]: https://voxpupuli.org/docs/releasing_version/ | ||
| [template]: https://github.com/voxpupuli/modulesync_config/blob/master/moduleroot/.github/CONTRIBUTING.md.erb | ||
| [forge]: https://github.com/puppetlabs/forge_issues/issues/new/choose | ||
| [approve]: https://github.com/puppetlabs/puppet-approved-modules/issues/new?assignees=&labels=&template=puppet-approved-modules.md&title= | ||
|
|
||