feat: add and document quickstart trial path#976
Merged
gildesmarais merged 9 commits intomainfrom May 10, 2026
Merged
Conversation
189691e to
1734e4f
Compare
396e395 to
ed001fb
Compare
f29f280 to
6fb0697
Compare
6fb0697 to
0200735
Compare
e5aeed0 to
4c54bbc
Compare
Comment on lines
+74
to
+76
| def load_yaml | ||
| template = File.read(CONFIG_FILE) | ||
| YAML.safe_load(ERB.new(template, trim_mode: '-').result, symbolize_names: true).freeze |
4c54bbc to
2526876
Compare
659d8d1 to
751fae7
Compare
751fae7 to
d7a742c
Compare
d7a742c to
3ac4729
Compare
This was referenced May 10, 2026
gildesmarais
added a commit
that referenced
this pull request
May 10, 2026
🤖 I have created a release *beep* *boop* --- ## [1.3.0](v1.2.0...v1.3.0) (2026-05-10) ### Features * add and document quickstart trial path ([#976](#976)) ([8bfe0ba](8bfe0ba)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This file contains hidden or 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
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.
Quickstart
Test drive the app with these steps:
docker compose -f docker-compose.quickstart.yml up -dhttp://localhost:4000/in your browserCHANGE_ME_ADMIN_TOKENThis pull request introduces a new quickstart mode for easier local testing, refines configuration and environment variable handling, and tightens security validation around access tokens. It also updates documentation to streamline onboarding and clarifies the development process. The most important changes are grouped below.
Quickstart and Onboarding Improvements:
quickstartjob to the CI workflow and a newdocker-compose.quickstart.ymlfor fast local setup, with a default admin access token for testing. [1] [2]README.mdto provide a simplified quickstart guide, removing older, more complex instructions and emphasizing the new workflow. [1] [2]Configuration and Environment Handling:
config/feeds.yml) to use an ERB template for the admin token, which now defaults to a runtime environment value. The configuration loader now supports ERB evaluation. [1] [2] [3]HTML2RSS_ACCESS_TOKENand related helpers inRuntimeEnv, and updated code and tests to use this new environment variable for authentication. [1] [2] [3] [4] [5] [6]Security and Validation Enhancements:
Code and Test Updates:
These changes collectively make local setup easier, improve security defaults, and ensure configuration is robust and testable.
Summary
What changed
docker-compose.quickstart.ymlas the minimal quickstart stackHTML2RSS_ACCESS_TOKENvia ERB-backed config loadingLocalConfig.load_snapshotbin/quickstart-verify,bin/quickstart-up, andbin/quickstart-downquickstartCI job that validates the rendered quickstart compose contractQuickstart behavior
RACK_ENV=developmentCHANGE_ME_ADMIN_TOKENHTML2RSS_WEB_IMAGEValidation
bin/quickstart-verifyruby -c bin/quickstart-verifybash -n bin/quickstart-upbash -n bin/quickstart-downdocker compose -f docker-compose.quickstart.yml config --format json