build: add gh workflow for building releases #327
Conversation
macintoshpie
force-pushed
the
build/automate-release-artifacts
branch
from
a6bb24c to
610547c
Compare
debug: publish debug: publish debug: uncomment release build: install xsltproc build: fix order build: add sudo to apt install build: remove test triggers
macintoshpie
force-pushed
the
build/automate-release-artifacts
branch
from
d6a7f4c to
700fec7
Compare
There was a problem hiding this comment.
This is great, thanks for automating as much as we can here. Few comments:
- I'm okay deprecating the json schema. We should add a note to the buildingsync.net website that it is deprecated though.
- I don't really remember why we were committing the DataDictionary and enumerations.json file. The files may be linked to from the BuildingSync.net website (maybe??).
- I really like that we are ridding ourselves of the proprietary/for-purchase software!
💥🤜🤛
| name: Checkout xs3p | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| repository: macintoshpie/xs3p |
There was a problem hiding this comment.
nice! should we move this to the buildingsync org? Not really concerned to be honest.
There was a problem hiding this comment.
I think that's a good idea, I'll create a repo
| uses: softprops/action-gh-release@v1 | ||
| with: | ||
| files: | | ||
| BuildingSync.xsd |
| ```bash | ||
| rake remove_tabs | ||
| ``` | ||
|
|
||
| * Update the CHANGELOG.md to include the latest changes, and the most recent version. | ||
|
|
||
| * Run the change_log.rb script (e.g. ruby src/change_log.rb -t abcdefghijklmnopqrstuvwxyz -s 2019-12-21). | ||
| * Copy the results of this into the CHANGELOG. Remove items that are not useful to an end user such as version bumps, formatting, etc. | ||
|
|
||
| * Create a Pull Request into `master` |
There was a problem hiding this comment.
probably should update this to main? Can you make a ticket to do that?
|
|
||
| At this point the GitHub action for publishing the release should be finished. Now we need to update the docs/data in [this repo](https://github.com/BuildingSync/website]). Check out the repo and make a new branch. | ||
|
|
||
| * Copy `index.html` from the release into `schema/vX.Y.Z/documentation/index.html`. |
There was a problem hiding this comment.
next level of awesomeness will be to automate this process too! (But of course with the new website.)
There was a problem hiding this comment.
I agree, I think we will need to create a new action for the site repo to just pull the release and its assets and auto copy/build the pages it needs
|
I build the schema doc locally and it looks okay. I really miss the graphical view, but it loaded really slow (if at all). Plus we should be encouraging the users to go to the selectiontool schema viewer (and eventually the new website). |
Any background context you want to provide?
What does this PR do?
Add a github workflow that's triggered on tag pushes, which builds the webpage along with the data dict stuff and adds it to the release.
The docs html is now being built with a forked version of this repo. It is now much smaller in size and faster.
Also deletes the json schema b/c we aren't using it. Also deletes enumerations.json and DataDictionary.xlsx b/c these are "built" files which are included in the release.
How should this be manually tested?
Once merged, push a test tag (non pre-release) and verify:
Then try it again with a pre-release tag (ie include vx.x.x-prx) and verify that it labels the release as a pre-release
What are the relevant tickets?
#305
Screenshots (if appropriate)