Skip to content

Commit

Permalink
Update various wiki docs
Browse files Browse the repository at this point in the history
+ references to the old file/directories
  • Loading branch information
cee-chen committed Nov 7, 2023
1 parent 4287f4b commit 6312ba1
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion wiki/contributing-to-eui/documenting/changelogs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelogs

All upcoming changelogs should go into the [upcoming_changelogs/](../../../upcoming_changelogs/_template.md) directory. Our release script automatically handles collating these files into our main [CHANGELOG.md](../../../CHANGELOG.md) on new EUI versions.
All upcoming changelogs should go into the [changelogs/upcoming/](../../../changelogs/upcoming/_template.md) directory. Our release script automatically handles collating these files on new EUI versions.

## When to write a changelog

Expand Down
8 changes: 4 additions & 4 deletions wiki/eui-team-processes/releasing-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ Ensure you are on the `main` branch, and then start the release process by runni
git checkout main && npm run release
```

This command ensures that you have the latest `upstream/main` and dependencies, as well as running all tests and then building the `lib` and `dist` distributions formats. Next the recent changes are read from `upcoming_changelogs/` and you will be asked to choose what part of the version to bump.
This command ensures that you have the latest `upstream/main` and dependencies, as well as running all tests and then building the `lib` and `dist` distributions formats. Next the recent changes are read from `changelogs/upcoming/` and you will be asked to choose what part of the version to bump.

![bumping a version](https://camo.githubusercontent.com/439b41058aa56f167867c4e118ef5e80c02c962f/68747470733a2f2f642e70722f692f51624b36614a2e676966)

After the version is bumped, the release script automatically updates `CHANGELOG.md` with the new release header and collated upcoming changelogs, and then cleans the `upcoming_changelogs/` directory. The updates are committed to git and tagged, then pushed to your `upstream` branch.
After the version is bumped, the release script automatically updates the most recent changelog with the new release header and collated upcoming changelogs, and then cleans the upcoming changelog directory. The updates are committed to git and tagged, then pushed to your `upstream` branch.

The latest changes have now been pushed to GitHub, a new `git` tag now exists on GitHub, the new release can be installed from `npm`, and the [documentation site][docs] will update momentarily.

Expand All @@ -52,10 +52,10 @@ To view the progress of your job or check for errors:

### Tag the release in GitHub

We also update the [release's tag in github](https://github.com/elastic/eui/tags) by _creating a release_ for the version and copying over its _CHANGELOG.md_ entries.
We also update the [release's tag in github](https://github.com/elastic/eui/tags) by _creating a release_ for the version and copying over its _CHANGELOG_ entries.
* Click the three dot menu on the right side of the latest tag, then click "Create release" from the flyout menu
* Type a lowercase "v" and the tag number into the release name field with no spaces
* Copy the _CHANGELOG.md_ entry into the release description. Do not included the linked version header.
* Copy the latest year's _CHANGELOG_ entry into the release description. Do not included the linked version header.
* (TODO: screencast this next time to include a GIF here)

## `@elastic/eslint-plugin-eui`
Expand Down
2 changes: 1 addition & 1 deletion wiki/eui-team-processes/upgrading-kibana.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ At this point, we recommend opening a **draft** PR with your existing commits/ch
The typical EUI upgrade PR in Kibana looks something like [#109157](https://github.com/elastic/kibana/pull/109157), and reviewers have begun to expect the consistency. There are two important inclusions:

* Call out changes made to accommodate test failures that might not be apparent from looking at the diff.
* Copy-paste the full [changelog version range](https://github.com/elastic/eui/blob/main/CHANGELOG.md) for the upgrade.
* Copy-paste the full changelog version range [from the latest changelog file](https://github.com/elastic/eui/blob/main/changelogs) for the upgrade.

Labels to use:

Expand Down

0 comments on commit 6312ba1

Please sign in to comment.