Skip to content

Commit f8d069b

Browse files
authored
Upload release-notes to S3 (#229)
1 parent 45ee2ef commit f8d069b

File tree

2 files changed

+98
-0
lines changed

2 files changed

+98
-0
lines changed

.github/workflows/publish.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,45 @@ jobs:
189189
SOURCE_DIR: site-pages/
190190
DEST_DIR: ${{ format('site-pages/{0}', github.ref_name) }}
191191

192+
- name: AWS Sync release-notes (production on GKE)
193+
if: matrix.publish && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push' && github.repository == 'boostorg/website-v2-docs'
194+
uses: jakejarvis/s3-sync-action@master
195+
with:
196+
args: --follow-symlinks --delete --exclude '.git/*' --exclude 'build/lib/*'
197+
env:
198+
AWS_S3_BUCKET: ${{ secrets.BOOST_PRODUCTION_BUCKET }}
199+
AWS_ACCESS_KEY_ID: ${{ secrets.BOOST_PRODUCTION_KEY_ID }}
200+
AWS_SECRET_ACCESS_KEY: ${{ secrets.BOOST_PRODUCTION_ACCESS_KEY }}
201+
AWS_REGION: 'us-east-2'
202+
SOURCE_DIR: release-notes/
203+
DEST_DIR: ${{ format('release-notes/{0}', github.ref_name) }}
204+
205+
- name: AWS Sync release-notes (staging on GKE)
206+
if: matrix.publish && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push' && github.repository == 'boostorg/website-v2-docs'
207+
uses: jakejarvis/s3-sync-action@master
208+
with:
209+
args: --follow-symlinks --delete --exclude '.git/*' --exclude 'build/lib/*'
210+
env:
211+
AWS_S3_BUCKET: ${{ secrets.BOOST_STAGE_BUCKET }}
212+
AWS_ACCESS_KEY_ID: ${{ secrets.BOOST_STAGE_KEY_ID }}
213+
AWS_SECRET_ACCESS_KEY: ${{ secrets.BOOST_STAGE_ACCESS_KEY }}
214+
AWS_REGION: 'us-east-2'
215+
SOURCE_DIR: release-notes/
216+
DEST_DIR: ${{ format('release-notes/{0}', github.ref_name) }}
217+
218+
- name: AWS Sync release-notes (cppal_dev on GKE)
219+
if: matrix.publish && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/develop') && github.event_name == 'push' && github.repository == 'boostorg/website-v2-docs'
220+
uses: jakejarvis/s3-sync-action@master
221+
with:
222+
args: --follow-symlinks --delete --exclude '.git/*' --exclude 'build/lib/*'
223+
env:
224+
AWS_S3_BUCKET: ${{ secrets.CPPAL_DEV_BUCKET }}
225+
AWS_ACCESS_KEY_ID: ${{ secrets.CPPAL_DEV_KEY_ID }}
226+
AWS_SECRET_ACCESS_KEY: ${{ secrets.CPPAL_DEV_ACCESS_KEY }}
227+
AWS_REGION: 'us-east-2'
228+
SOURCE_DIR: release-notes/
229+
DEST_DIR: ${{ format('release-notes/{0}', github.ref_name) }}
230+
192231
- name: Publish Releases as Artifacts
193232
if: matrix.publish && github.event_name == 'push'
194233
uses: actions/upload-artifact@v3

release-notes/template.adoc

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
////
2+
Copyright (c) 2024 The C++ Alliance, Inc. (https://cppalliance.org)
3+
Distributed under the Boost Software License, Version 1.0. (See accompanying
4+
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
5+
Official repository: https://github.com/boostorg/website-v2-docs
6+
////
7+
= Release Notes
8+
These are the release notes for Boost version X.XX.XX.
9+
== New Libraries
10+
// List new libraries in lexicographical order (library name, purpose, authors)
11+
// Example:
12+
// * Accumulators : performs incremental calculation, and collection of statistical accumulators, from Eric Niebler.
13+
* Library 1 name : purpose, author
14+
* Library 2 name : purpose, author
15+
== Updated Libraries
16+
// List updated libraries in lexicographical order.
17+
// Example:
18+
// * Interprocess
19+
// ** Dependency on Boost.TypeTraits removed
20+
// ** Shared memory feature added
21+
// ** Support for C++ 03 removed
22+
* Library 1 name
23+
** update 1 text
24+
*** indented note for update 1, if needed
25+
*** another indented note for update 1, if needed
26+
** update 2 text
27+
** update 3 text
28+
* Library 2 name
29+
** update 1 text
30+
*** indented note for update 1, if needed
31+
*** another indented note for update 1, if needed
32+
** update 2 text
33+
** update 3 text
34+
== Compilers Tested
35+
// Edit this section as approrpriate
36+
Boost's primary test compilers are:
37+
* Linux:
38+
** Clang, C++03: 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 12.0.0, 13.0.0, 14.0.0, 15.0.0
39+
** Clang, C++11: 3.4, 11.0.0, 13.0.0, 14.0.0, 15.0.0
40+
** Clang, C++14: 3.5, 3.6, 3.7, 3.8, 3.9, 4.0, 5.0, 12.0.0, 13.0.0, 14.0.0, 15.0.0
41+
** Clang, C++17: 6.0.1, 7.0.0, 8.0.0, 9.0.0, 10.0.0, 11.0.0, 12.0.0, 13.0.0, 14.0.0, 15.0.0
42+
** Clang, C++20: 11.0.0, 12.0.0, 13.0.0, 14.0.0, 15.0.0
43+
** GCC, C++03: 4.6.3, 11, 12
44+
** GCC, C++11: 4.7.3, 4.8.5, 11, 12
45+
** GCC, C++14: 5.4.0, 6.4.0, 7.3.0, 8.0.1, 9.1.0, 11, 12
46+
** GCC, C++17: 7.3.0, 8.0.1, 9.1.0, 11, 12
47+
** GCC, C++20: 8.0.1, 9.1.0, 10, 11, 12
48+
* OS X:
49+
** Apple Clang, C++03: 11.0.3
50+
** Apple Clang, C++11: 11.0.3
51+
** Apple Clang, C++14: 11.0.3
52+
** Apple Clang, C++17: 11.0.3
53+
** Apple Clang, C++20: 11.0.3
54+
* Windows:
55+
** Visual C++: 10.0, 11.0, 12.0, 14.0, 14.1, 14.2, 14.3
56+
== Acknowledgements
57+
// Example: * Marshall Clow and Glen Fernandes managed this release.
58+
* ack 1
59+
* ack 2

0 commit comments

Comments
 (0)