@@ -220,13 +220,6 @@ and fix them; assign them to a milestone (like <code>{customField('xpackVersion'
220
220
221
221
### Update ` CHANGELOG.md `
222
222
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
-
230
223
To turn the dates into headings , change from :
231
224
232
225
` ` ` txt
257
250
*
258
251
` ` `
259
252
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
+
260
261
### Push the changes to the ` xpack-development ` branch
261
262
262
263
Be sure that the latest commit that updates ` VERSION ` is pushed
@@ -584,7 +585,7 @@ rm -rf ~/Work/xpack-dev-tools/*/build-assets/build
584
585
585
586
### Generate the GitHub workflows
586
587
587
- Run the ** generate - workflows ** xPack action to update the
588
+ Run the ** generate - workflows ** xpm / xPack action to update the
588
589
GitHub workflow files .
589
590
590
591
` ` ` sh
@@ -619,7 +620,7 @@ xpm run trigger-workflow-build-linux-arm64 -C ~/Work/xpack-dev-tools/arm-none-ea
619
620
xpm run trigger-workflow-build-linux-arm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
620
621
` ` `
621
622
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 `
623
624
variable to be present
624
625
in the environment , and the organization ` PUBLISH_TOKEN ` to be visible in the
625
626
Settings → Action →
@@ -663,7 +664,7 @@ xpm run trigger-workflow-test-docker-linux-x64 -C ~/Work/xpack-dev-tools/arm-non
663
664
xpm run trigger-workflow-test-docker-linux-arm -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-xpack.git/build-assets
664
665
` ` `
665
666
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
667
668
in the environment .
668
669
669
670
These actions use the ` xpack-development ` branch of this repo and the
@@ -688,7 +689,7 @@ with previous runs.
688
689
Since GitHub Actions provides a limited range of versions for the macOS
689
690
runner , the multi - version macOS tests run on Travis .
690
691
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 :
692
693
693
694
` ` ` sh
694
695
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-*
733
734
- commit with the message _ ** CHANGELOG update ** _
734
735
- check and possibly update the ` build-assets/templates/body-github-release-liquid.mdx `
735
736
- 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 :
737
738
738
739
` ` ` sh
739
740
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.
754
755
- do ** not ** enable Discussions yet
755
756
- click the ** Publish release ** button
756
757
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
+ :::
759
764
760
765
### Prepare a new blog post
761
766
762
767
- 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 ;
764
769
this will add a file in the ` website/blog ` folder :
765
770
766
771
` ` ` sh
@@ -769,7 +774,7 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-x
769
774
770
775
- edit the front matter properties
771
776
- 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 ** _
773
778
774
779
### Update the web install page
775
780
@@ -780,15 +785,15 @@ xpm run generate-website-blog-post -C ~/Work/xpack-dev-tools/arm-none-eabi-gcc-x
780
785
781
786
### Check the list of links in top package .json
782
787
783
- - open the ` package.json ` file
788
+ - open the top ` package.json ` file
784
789
- check if the links in the ` bin ` property cover the actual binaries
785
790
- if necessary , also check on Windows
786
791
787
792
### Update the package .json list of binaries
788
793
789
794
- select the ` xpack-development ` branch
790
795
- 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 :
792
797
793
798
` ` ` sh
794
799
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
838
843
839
844
### Test if the binaries can be installed with xpm
840
845
841
- Run the ** trigger - workflow - test - xpm ** xPack action :
846
+ Run the ** trigger - workflow - test - xpm ** xpm / xPack action :
842
847
843
848
` ` ` sh
844
849
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
855
860
856
861
When the release is considered stable , promote it as ` latest ` :
857
862
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
+
858
869
<CodeBlock language = " sh" > {
859
870
` 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
862
871
` } </CodeBlock >
863
872
864
873
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:
872
881
Validate the web site content in a local build via the npm ` build ` script :
873
882
874
883
` ` ` sh
875
- npm --prefix website run build
884
+ npm run build -C website
876
885
` ` `
877
886
878
887
### Publish the website
879
888
889
+ - stop the local web server
890
+ - select the ` website ` branch
880
891
- merge ` xpack-development ` into ` website `
881
892
- 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
+ :::
885
896
- the new release blog post is
886
897
in https :// xpack-dev-tools.github.io/arm-none-eabi-gcc-xpack/blog/
887
898
- remember the post URL , since it must be used to update the release page
888
899
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
889
901
890
902
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 .
892
904
893
905
### Update the ` xpack ` branch
894
906
@@ -910,7 +922,8 @@ Avoid further updates to the `xpack` branch until the next release.
910
922
- check the download counter , it should match the number of tests
911
923
- add a link to the Web blog ` [Continue reading »]() ` ; use an same blog URL
912
924
- 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
914
927
- click the ** Update Release ** button
915
928
916
929
### Check SourceForge mirror
@@ -926,7 +939,7 @@ Avoid further updates to the `xpack` branch until the next release.
926
939
927
940
### Clean the work area
928
941
929
- Run the ** trigger - workflow - deep - clean ** xPack action
942
+ Run the ** trigger - workflow - deep - clean ** xpm / xPack action
930
943
931
944
` ` ` sh
932
945
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.
937
950
The results are available from the
938
951
[GitHub Actions ](https :// github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/actions/) page.
939
952
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
+
940
962
## Share on Twitter
941
963
942
964
- in a separate browser windows , open [X / Twitter ](https :// twitter.com)
0 commit comments