Skip to content

Commit

Permalink
docs: Clarify additional mods needed after migrate (#137)
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleTryon authored Mar 31, 2022
1 parent c1add86 commit a0cfc63
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,14 @@ Version 11.0.0 of orb-tools is composed of a major re-write that greatly changes
5. Run the script
- `chmod +x migrate.sh`
- `bash migrate.sh`

6. After executing the script:

- The script will ask you for some basic information about your orb, such as the namespace, name of the orb, and name of your publishing context. All of this information is present in your existing configuration.
- Your existing configuration will be renamed to `config.yml.bak`
- Two new configuration files will be downloaded from the template repository and modified with your inputs.
- The migrate script will self-delete.
- You will be asked to modify the generated `.circleci/test-deploy` to ensure any jobs you have defined and orb jobs are tested.

7. _(OPTIONAL)_ Enable PR comments.

Expand Down

0 comments on commit a0cfc63

Please sign in to comment.