Overhaul README and related updates #313
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
delano
added
documentation
ruby3
PR Review(Review updated until commit ed0b589)
|
|
Persistent review updated to latest commit ed0b589 |
onetimesecret
commented
Apr 11, 2024
|
|
||
| When you send people sensitive info like passwords and private links via email or chat, there are copies of that information stored in many places. If you use a one-time link instead, the information persists for a single viewing which means it can't be read by someone else later. This allows you to send sensitive information in a safe way knowing it's seen by one person only. Think of it like a self-destructing message. | ||
|
|
||
| ## How to install | ||
|
|
||
| ## Installation |
There was a problem hiding this comment.
Consider adding a section on "Upgrading" with instructions on how to upgrade to a newer version of Onetime Secret. This could include steps like backing up the config files, pulling the latest Docker image, and any database migrations that may be required. [medium]
Ruby, Rubygems, and Bundler.
--- Run ruby/setup-ruby@v1 Modifying PATH Downloading Ruby Extracting Ruby Print Ruby version Updating RubyGems Installing Bundler > bundle install /opt/hostedtoolcache/Ruby/3.2.0/x64/bin/bundle config --local path /home/runner/work/onetimesecret/onetimesecret/vendor/bundle /opt/hostedtoolcache/Ruby/3.2.0/x64/bin/bundle config --local deployment true Cache key: setup-ruby-bundler-cache-v6-ubuntu-22.04-x64-ruby-3.2.0-wd-/home/runner/work/onetimesecret/onetimesecret-with--without--only--Gemfile.lock-4129b5b29d25d36df50d02bd4e134d7d5987e7656d15fd828b6922acc99e7746 /opt/hostedtoolcache/Ruby/3.2.0/x64/bin/bundle install --jobs 4 Fetching gem metadata from https://rubygems.org/. Resolving dependencies... Fetching bundler-graph 0.2.1 Installing bundler-graph 0.2.1 Installed plugin bundler-graph The Ruby version ruby 3.2 from /home/runner/work/onetimesecret/onetimesecret/Gemfile.lock could not be parsed. Try running bundle update --ruby to resolve this. Error: The process '/opt/hostedtoolcache/Ruby/3.2.0/x64/bin/bundle' failed with exit code 20
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.
This pull request updates the README.md, docker-compose.yaml, and ruby matrix workflow for the v0.13.0 release of Onetime Secret.
Changes
Docker compose
Docker
README.md
These updates aim to provide clearer and more comprehensive documentation for installing, configuring, and running Onetime Secret, especially for the latest v0.13.0 release with Ruby 3+ support.
.github/workflows/ruby.yaml
Updates the Ruby versions matrix to specify the bundled and rubygem versions to use for each Ruby version. This ensures consistent dependencies.