Version 1.1.0 #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Well, well, well, if it isn't the consequences of my own actions. Rebased PR on base branch after doing the fuckery to fix git blame for v1.0.0 in main. This mess is a product of my own incompetence. |
|
Re-signed unverified commits since GitHub's auto rebase doesn't sign them. What a mess. |
Forgot to document this in the fix that removed sed from header generation
#3) A user might want to use XML reserved characters in their page metadata, not realising that this would break the sitemap or RSS feed. This PR implements a cleaner function to ensure such characters are automatically replaced with escape codes at runtime. This PR also adds a new unit test to make sure that the sanitisation actually works so that we don't break it down the line.
neonspectra
added
the
arise version
…aging (#5) The way the deployment workflow worked originally is that it was hardcoded to deploy to a branch html, so if we wanted to test changes in staging we had to manually edit the workflow. This PR adds a check to determine whether the branch we're working on is main or not. If it's main, deployments go to production. If it's not, deployments go to staging.
|
Tested and verified it works. Also dogfooded this on my personal website to make sure nothing breaks. This new version is good to go! |
github-actions bot
pushed a commit
that referenced
this pull request
Nov 17, 2023
# Arise v1.1.0
---
## Changelog
- Bumped `actions/checkout@v2` to `actions/checkout@v4`. No impact from this change.
- Removed `sed` from the metadata tag evaluation in `build_header`. Replaced with Bash native pattern matching so that this evaluation is safer.
- Added checks to automatically rewrite any XML reserved characters (&<>'") as their escape codes when present in page metadata (title, author, etc).
- Rewrote the way a majority of the page metadata values are parsed in `get_page_metadata` to make the parsing more robust. This was necessary because previously unescaped double quotes (`"`) would break the parser. The workaround was to use escape codes, but if we're automatically parsing escape codes then we need a way to put these characters in unescaped now.
- Added a CI test suite to build the default site and test to make sure that the XML reserved characters are getting properly escaped. This is helpful because it allows me to more continuously ensure that commits I make in dev don't break the site.
- Added a Smart Deploy step in the deployment workflow to check whether the triggering branch is `main` or not so that CICD can intelligently deploy the site to either production or staging depending on what branch triggered the deployment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Arise v1.1.0
Changelog
actions/checkout@v2toactions/checkout@v4. No impact from this change.sedfrom the metadata tag evaluation inbuild_header. Replaced with Bash native pattern matching so that this evaluation is safer.get_page_metadatato make the parsing more robust. This was necessary because previously unescaped double quotes (") would break the parser. The workaround was to use escape codes, but if we're automatically parsing escape codes then we need a way to put these characters in unescaped now.mainor not so that CICD can intelligently deploy the site to either production or staging depending on what branch triggered the deployment.