You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Describe remaining migration work
* Don't dev-publish for forked-PRs. Only pack if tests worked
* Example should only dev-publish for forked-PRs and only pack if tests worked
* Moved changes to test-deploy.yml and example to new PRs
---------
Co-authored-by: marboledacci <mateo.arboleda@circleci.com>
Copy file name to clipboardExpand all lines: MIGRATION.md
+32-1Lines changed: 32 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,8 @@ _Note: If you are upgrading from 11.x to 12.x proceed here. If you are upgrading
10
10
11
11
-**Removed the need for a dev publishing token**
12
12
- Previously, after the orb was built, it would be published to a development tag and referenced in the test pipeline. This required a publishing token to be present in the dev pipeline.
13
-
- The dynamic configuration system allows us to inject the orb directly into the pipeline as an "in-line" orb, allowing for orb testing without the need for access to a publishing token.
13
+
- The dynamic configuration system allows us to inject the orb directly into the pipeline as an "in-line" orb, allowing for orb testing without the need for access to a publishing token,
14
+
thus allowing forked-PR builds to "build and test" securely.
14
15
-**Snake_Case Renamed Components**
15
16
- To keep consistency with CircleCI's _native_ configuration schema, all components and parameters have been renamed to use snake_case.
16
17
(Example: `parameter-name` -> `parameter_name`)
@@ -21,16 +22,46 @@ _Note: If you are upgrading from 11.x to 12.x proceed here. If you are upgrading
21
22
22
23
1. Clone your orb project locally.
23
24
1. Create a new branch for upgrading your pipeline
25
+
24
26
```sh
25
27
git checkout -b orb-tools-12-migration
26
28
````
29
+
27
30
1. Copy the `migrate.sh` script from this repository into your project's root directory.
28
31
1. Run the script
32
+
29
33
```sh
30
34
chmod +x migrate.sh && ./migrate.sh
31
35
```
32
36
33
37
After executing the script, your orb's component names and parameters will be converted to snake_case, and references to them within your config files will be updated. The reference to your orb in the `test-deploy` config will be removed, as the orb will now be dynamically injected into the pipeline.
38
+
39
+
1. Edit your project's `.circleci/config.yml` file.
- Add an extra call to the "pack" job (`orb-tools/pack`) and ensure that the publish job(s) `require:` it.
58
+
- Consider adding an extra call to the "publish" job to reinstate the "dev publish" removed from the `config.yml` build file.
59
+
- Not all users will require this; this is only necessary if dev publishes of unreleased orbs are needed for use by other projects.
60
+
- Consider setting a filter to ensure that the dev publish doesn't happen for release builds (i.e. no tags) or for external (forked) PR builds (i.e. no branches matching `/^pull/[0-9]+$/`).
61
+
- Make the "pack" job `require:` all your test jobs and then have the publish job(s) `require:` the pack job.
62
+
63
+
---
64
+
34
65
## v11.0.0
35
66
36
67
Version 11.0.0 of orb-tools is composed of a major re-write that greatly changes and improves the way orbs are deployed, makes use of CircleCI's [dynamic configuration](https://circleci.com/docs/2.0/dynamic-config/), and can even automatically testfor best practices.
0 commit comments