Skip to content

Commit f6f1546

Browse files
committed
website: updates
1 parent 358b5e4 commit f6f1546

File tree

3 files changed

+73
-41
lines changed

3 files changed

+73
-41
lines changed

website/docs/developer/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -186,14 +186,14 @@ xpm/xPack actions and build configurations are supported in Visual Studio via th
186186
With this extension installed, xpm/xPack actions can be very conveniently
187187
invoked via a single mouse click, for example:
188188

189-
![xPack actions](https://github.com/xpack/vscode-xpack-extension-ts/raw/master/assets/docs-images/xpack-actions.png)
189+
![xpm actions](https://github.com/xpack/vscode-xpack-extension-ts/raw/master/assets/docs-images/xpack-actions.png)
190190

191191
</details>
192192

193193
## Prerequisites
194194

195195
The build scripts run on GNU/Linux and macOS. The Windows binaries are
196-
compiled on x64 GNU/Linux, using [mingw-w64](https://mingw-w64.org).
196+
compiled on GNU/Linux, using [mingw-w64](https://mingw-w64.org).
197197

198198
For details on installing the prerequisites, please read the
199199
[Build Prerequisites](https://xpack-dev-tools.github.io/docs/developer/install/prerequisites/)

website/docs/maintainer/index.mdx

+50-28
Original file line numberDiff line numberDiff line change
@@ -220,13 +220,6 @@ and fix them; assign them to a milestone (like <code>{customField('xpackVersion'
220220

221221
### Update `CHANGELOG.md`
222222

223-
- open the `CHANGELOG.md` file
224-
- check if all previous fixed issues are in
225-
- check the latest commits `xpm run git-log`; if necessary, copy/paste lines,
226-
group by dates and edit them using the below regular expressions
227-
- add a new entry like _**\* v{customField('xpackVersion')} prepared**_
228-
- commit with the message _**prepare v{customField('xpackVersion')}**_
229-
230223
To turn the dates into headings, change from:
231224

232225
```txt
@@ -257,6 +250,14 @@ to:
257250
*
258251
```
259252

253+
- open the `CHANGELOG.md` file
254+
- check if all previous fixed issues are in
255+
- check the latest commits `xpm run git-log`; if necessary, copy/paste lines,
256+
group by dates and edit them using the below regular expressions
257+
- add a new entry like _**\* v{customField('xpackVersion')} prepared**_
258+
- commit with the message _**prepare v{customField('xpackVersion')}**_
259+
260+
260261
### Push the changes to the `xpack-development` branch
261262

262263
Be sure that the latest commit that updates `VERSION` is pushed
@@ -584,7 +585,7 @@ rm -rf ~/Work/xpack-dev-tools/*/build-assets/build
584585

585586
### Generate the GitHub workflows
586587

587-
Run the **generate-workflows** xPack action to update the
588+
Run the **generate-workflows** xpm/xPack action to update the
588589
GitHub workflow files.
589590

590591
```sh
@@ -619,7 +620,7 @@ xpm run trigger-workflow-build-linux-arm64 -C ~/Work/xpack-dev-tools/arm-none-ea
619620
xpm run trigger-workflow-build-linux-arm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
620621
```
621622

622-
The scripts behind these actions require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN`
623+
The scripts behind these actions require the `GITHUB_API_DISPATCH_TOKEN`
623624
variable to be present
624625
in the environment, and the organization `PUBLISH_TOKEN` to be visible in the
625626
SettingsAction
@@ -663,7 +664,7 @@ xpm run trigger-workflow-test-docker-linux-x64 -C ~/Work/xpack-dev-tools/arm-non
663664
xpm run trigger-workflow-test-docker-linux-arm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
664665
```
665666

666-
The scripts behind these accessible require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN` variable to be present
667+
The scripts behind these accessible require the `GITHUB_API_DISPATCH_TOKEN` variable to be present
667668
in the environment.
668669

669670
These actions use the `xpack-development` branch of this repo and the
@@ -688,7 +689,7 @@ with previous runs.
688689
Since GitHub Actions provides a limited range of versions for the macOS
689690
runner, the multi-version macOS tests run on Travis.
690691

691-
To trigger the Travis test, run the **trigger-travis-macos** xPack action:
692+
To trigger the Travis test, run the **trigger-travis-macos** xpm/xPack action:
692693

693694
```sh
694695
xpm run trigger-travis-macos -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -733,7 +734,7 @@ xattr -cr ${HOME}/Downloads/xpack-*
733734
- commit with the message _**CHANGELOG update**_
734735
- check and possibly update the `build-assets/templates/body-github-release-liquid.mdx`
735736
- push the `xpack-development` branch to GitHub
736-
- run the **trigger-workflow-publish-release** xPack action:
737+
- run the **trigger-workflow-publish-release** xpm/xPack action:
737738

738739
```sh
739740
xpm run trigger-workflow-publish-release -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -754,13 +755,17 @@ with all binaries attached.
754755
- do **not** enable Discussions yet
755756
- click the **Publish release** button
756757

757-
Note: at this moment the system should send a notification to all clients
758-
watching this project.
758+
:::info
759+
760+
At this moment the system should send an email notification to all clients
761+
watching the arm-none-eabi-gcc-xpack project.
762+
763+
:::
759764

760765
### Prepare a new blog post
761766

762767
- check and possibly update the `website/blog/_templates/blog-post-release-part-[12]-liquid.md`
763-
- run the **generate-website-blog-post** xPack action;
768+
- run the **generate-website-blog-post** xpm/xPack action;
764769
this will add a file in the `website/blog` folder:
765770

766771
```sh
@@ -769,7 +774,7 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-x
769774

770775
- edit the front matter properties
771776
- select the correct summary
772-
- commit with the message _**blog post release {customField('xpackVersion')} published**_
777+
- commit with the message _**website: blog post release {customField('xpackVersion')} published**_
773778

774779
### Update the web install page
775780

@@ -780,15 +785,15 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-x
780785

781786
### Check the list of links in top package.json
782787

783-
- open the `package.json` file
788+
- open the top `package.json` file
784789
- check if the links in the `bin` property cover the actual binaries
785790
- if necessary, also check on Windows
786791

787792
### Update the package.json list of binaries
788793

789794
- select the `xpack-development` branch
790795
- be sure that the binaries were attached to the pre-release
791-
- run the **update-package-binaries** xPack action:
796+
- run the **update-package-binaries** xpm/xPack action:
792797

793798
```sh
794799
xpm run update-package-binaries -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -838,7 +843,7 @@ After a few moments the version will be visible at
838843

839844
### Test if the binaries can be installed with xpm
840845

841-
Run the **trigger-workflow-test-xpm** xPack action:
846+
Run the **trigger-workflow-test-xpm** xpm/xPack action:
842847

843848
```sh
844849
xpm run trigger-workflow-test-xpm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -855,10 +860,14 @@ The tests results are available from the
855860

856861
When the release is considered stable, promote it as `latest`:
857862

863+
<CodeBlock language="sh"> {
864+
`npm dist-tag add @xpack-dev-tools/arm-none-eabi-gcc@${customField('xpackVersion')}.${customField('npmSubversion')} latest
865+
`} </CodeBlock>
866+
867+
Check the result:
868+
858869
<CodeBlock language="sh"> {
859870
`npm dist-tag ls @xpack-dev-tools/arm-none-eabi-gcc
860-
npm dist-tag add @xpack-dev-tools/arm-none-eabi-gcc@${customField('xpackVersion')}.${customField('npmSubversion')} latest
861-
npm dist-tag ls @xpack-dev-tools/arm-none-eabi-gcc
862871
`} </CodeBlock>
863872

864873
In case the release proves problematic and needs to be unpublished:
@@ -872,23 +881,26 @@ In case the release proves problematic and needs to be unpublished:
872881
Validate the web site content in a local build via the npm `build` script:
873882

874883
```sh
875-
npm --prefix website run build
884+
npm run build -C website
876885
```
877886

878887
### Publish the website
879888

889+
- stop the local web server
890+
- select the `website` branch
880891
- merge `xpack-development` into `website`
881892
- push the `website` branch to GitHub
882-
883-
At this moment an automated GitHub Action will generate and publish the website.
884-
893+
:::info
894+
At this moment an automated GitHub Action will generate and publish the website.
895+
:::
885896
- the new release blog post is
886897
in https://xpack-dev-tools.github.io/arm-none-eabi-gcc-xpack/blog/
887898
- remember the post URL, since it must be used to update the release page
888899
and the X/Twitter announcement
900+
- switch to https://xpack-dev-tools.github.io/arm-none-eabi-gcc-xpack/docs/maintainer/#update-the-xpack-branch
889901

890902
The `website` branch may be subsequently updated, as long as the
891-
version in `package.json` is not changed.
903+
version in the top `package.json` is not changed.
892904

893905
### Update the `xpack` branch
894906

@@ -910,7 +922,8 @@ Avoid further updates to the `xpack` branch until the next release.
910922
- check the download counter, it should match the number of tests
911923
- add a link to the Web blog `[Continue reading »]()`; use an same blog URL
912924
- remove the _tests only_ notice
913-
- **disable** the **pre-release** button
925+
- **disable** the **Set as a pre-release** button
926+
- **enable** the **Set as the latest release** button
914927
- click the **Update Release** button
915928

916929
### Check SourceForge mirror
@@ -926,7 +939,7 @@ Avoid further updates to the `xpack` branch until the next release.
926939

927940
### Clean the work area
928941

929-
Run the **trigger-workflow-deep-clean** xPack action
942+
Run the **trigger-workflow-deep-clean** xpm/xPack action
930943

931944
```sh
932945
xpm run trigger-workflow-deep-clean -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
@@ -937,6 +950,15 @@ This will remove the build folders on all self-hosted runners.
937950
The results are available from the
938951
[GitHub Actions](https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/actions/) page.
939952

953+
### Close possible open issues
954+
955+
Check GitHub issues and pull requests:
956+
957+
- https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/issues
958+
- https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/pulls
959+
960+
Close those that were addressed.
961+
940962
## Share on Twitter
941963

942964
- in a separate browser windows, open [X/Twitter](https://twitter.com)

website/docusaurus.config.ts

+21-11
Original file line numberDiff line numberDiff line change
@@ -335,19 +335,29 @@ const config: Config = {
335335
'aria-label': 'GitHub repository',
336336
},
337337
{
338-
label: `v${customFields.xpackVersion}`,
339-
position: 'right',
340-
href: `https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/tag/v${customFields.xpackVersion}`,
341-
},
342-
{
343-
href: 'https://github.com/xpack-dev-tools/',
344-
label: 'xpack-dev-tools',
338+
type: 'dropdown',
339+
href: 'https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/',
345340
position: 'right',
341+
label: 'GitHub',
342+
items: [
343+
{
344+
label: `arm-none-eabi-gcc-xpack`,
345+
href: `https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/`,
346+
},
347+
{
348+
label: 'xpack-dev-tools org',
349+
href: 'https://github.com/xpack-dev-tools/',
350+
},
351+
{
352+
label: 'xpack org',
353+
href: 'https://github.com/xpack/',
354+
},
355+
]
346356
},
347357
{
348-
href: 'https://github.com/xpack/',
349-
label: 'xpack',
358+
label: `${customFields.xpackVersion}`,
350359
position: 'right',
360+
href: `https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/tag/v${customFields.xpackVersion}`,
351361
},
352362
],
353363
},
@@ -408,11 +418,11 @@ const config: Config = {
408418
href: 'https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/',
409419
},
410420
{
411-
label: 'GitHub xpack-dev-tools',
421+
label: 'GitHub xpack-dev-tools org',
412422
href: 'https://github.com/xpack-dev-tools/',
413423
},
414424
{
415-
label: 'GitHub xpack',
425+
label: 'GitHub xpack org',
416426
href: 'https://github.com/xpack/',
417427
},
418428
],

0 commit comments

Comments
 (0)