Skip to content

Commit 70389ff

Browse files
authored
repo sync
2 parents 86cf41e + 050b95d commit 70389ff

2 files changed

Lines changed: 9 additions & 7 deletions

File tree

.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,21 @@
3434
```
3535
☝️ This will run a workflow **on every push to the PR** that will sync **only** the English index for the new version to Algolia. This will make the GHES content searchable on staging throughout content creation, and will ensure the search updates go live at the same time the content is published. See [`contributing/search.md`](https://github.com/github/docs-internal/blob/main/contributing/search.md) for details.
3636
37-
- [ ] Create an OpenAPI topic branch
38-
39-
This branch is used to avoid propagating the OpenAPI dev mode check CI test failure in all of the branches. All changes that affect the OpenAPI schema should branch off of this topic branch. The tests should all be passing before the OpenAPI topic branch is merged into the megabranch.
40-
41-
For more information about how OpenAPI changes are published to docs.github.com, see [Publishing REST API changes to docs.github.com](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/publishing-documentation/publishing-REST-api-docs.md#publishing-rest-api-changes-to-docsgithubcom).
42-
4337
- [ ] In `github/github`, to create a new GHES release follow these steps:
4438
- [ ] Copy the previous release's root document to a new root document for this release `cp app/api/description/ghes-<LATEST RELEASE NUMBER>.yaml app/api/description/ghes-<NEXT RELEASE NUMBER>.yaml`.
4539
- [ ] Update the `externalDocs.url` property in that file to use the new GHES release number.
4640
- [ ] Copy the previous release's configuration file to a new configuration file for this release `cp app/api/description/config/releases/ghes-<LATEST RELEASE NUMBER>.yaml app/api/description/config/releases/ghes-<NEXT RELEASE NUMBER>.yaml`.
4741
- [ ] Update the `variables.externalDocsUrl`, `variables.ghesVersion`, and `patch.[].value.url` in that file to use the new GHES release number.
4842
- [ ] Update `published` in that file to `false`. **Note:** This is important to ensure that 3.1 OpenAPI changes are not made public until 3.1 is released.
4943
44+
#### Troubleshooting
45+
46+
If the `OpenAPI dev mode check / check-schema-versions` check fails on the release branch, in your local checkout of the mega branch:
47+
48+
- run `git checkout origin/main lib/rest/static/*`
49+
- run `script/rest/update-files.js --decorate-only`
50+
- push the resulting changes
51+
5052
### Before shipping the release branch
5153
5254
- [ ] Add the GHES release notes to `data/release-notes/` and update the versioning frontmatter in `content/admin/release-notes.md` to `enterprise-server: '<=<RELEASE>'`

content/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ topics:
2020
![New milestone button](/assets/images/help/repository/new-milestone.png)
2121
- To edit a milestone, next to the milestone you want to edit, click **Edit**.
2222
![Edit milestone option](/assets/images/help/repository/edit-milestone.png)
23-
5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**.
23+
5. Type the milestone's title, description, or other changes, and click **Create milestone** or **Save changes**. Milestones will render Markdown syntax. For more information about Markdown syntax, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)."
2424

2525
### Deleting milestones
2626

0 commit comments

Comments
 (0)