Update publishing docs #430
Merged
Conversation
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
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-430
NickColley
approved these changes
Jan 12, 2018
36degrees
reviewed
Jan 12, 2018
docs/publishing.md
Outdated
|
|
||
| 3. For any new components, add a `package.json` inside `packages/component-name`: | ||
| 3. Ensure all changes to `src/components/component-name` have been copied to `packages/component-name`. In order to verify this, do the following in the Design System: |
There was a problem hiding this comment.
I think this is worth doing, but doing this only verifies that the compiled packages work - it doesn't mean that all of the changes have been copied.
There was a problem hiding this comment.
Good point. I've reworded this to make it clearer.
docs/publishing.md
Outdated
| @@ -6,53 +6,49 @@ Lerna is a tool that optimizes the workflow around managing multi-package reposi | |||
|
|
|||
| It manages dependencies between our components so that if the version number of `globals` is bumped, all components dependent on `globals` will also have their version bumped. | |||
|
|
|||
| ### Publishing components manually (while in Alpha) | |||
| ### Publishing components manually (while in Alpha/Private beta) | |||
|
|
|||
| In a new branch: | |||
There was a problem hiding this comment.
Do we want something about making sure you're up to date with the latest changes to master?
docs/publishing.md
Outdated
| ``` | ||
|
|
||
| 6. Open a pull request for these changes. | ||
| Here, leave the version number blank to allow Lerna to complete it as part of `lerna publish`. Include any dependencies, such as the `icons` package, that the new component requires. Use the current version number of any packages that you include here, Lerna will update the version number as part of `lerna publish`. |
|  | ||
|
|
||
| Then in a new branch: | ||
| 11. If your changes included new packages, you need to grant the test user access to them: |
hannalaakso
force-pushed
the
update-publish-docs
branch
from
f91c33d
to
c929bba
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-430
|
👏 |
|
@NickColley Yes I confirmed with @igloosi that a PR halfway through is unnecessary. I'm leaving the PR open as I'd like @igloosi to cast his eye over the changes as well. |
hannalaakso
force-pushed
the
update-publish-docs
branch
from
c929bba
to
621b733
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-review-pr-430
hannalaakso
force-pushed
the
update-publish-docs
branch
from
621b733
to
2013c45
Compare
|
it's fine. not sure about having to push tags. last release i did lerna publish pushed all git tags to remote and a commit with all the package.json changes |
kr8n3r
approved these changes
Jan 15, 2018
This was referenced Jan 18, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the publish docs with more information, especially around managing NPM test user's access to new/deprecated packages.
Note: I am not convinced we need to include the steps for verifying changes by linking the package styles to the Design System (step 3) because we need an altogether better process of managing this step.