rundoc 1.1.2 → 2.0.0

data/test/fixtures/rails_4/rundoc.md

@@ -1,5 +1,5 @@
 ```
-:::- rundoc
+:::-- rundoc
 email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`
 
 Rundoc.configure do |config|
@@ -9,11 +9,19 @@ end
 ```
 <!--
   rundoc src:
-  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_4/rundoc.md
+  https://github.com/schneems/rundoc/blob/main/test/fixtures/rails_4/rundoc.md
 -->
 
 > warning
-> The latest version of Rails available is [Rails 5](https://devcenter.heroku.com/articles/getting-started-with-rails5). If you are starting a new application we recommend you use the most recently released version.
+> This article is archived. It is no longer receiving updates. It is presented here for historical reference only.
+> We cannot guarantee that any statements made are correct or that the instructions will still work.
+> This version of Rails is [no longer supported by Ruby core](https://guides.rubyonrails.org/maintenance_policy.html).
+> If you are starting a new application, we recommend you use the most recently released version of Rails.
+
+>warning
+>As of November 28th, 2022, free Heroku dynos, free Heroku Postgres and free Heroku Data for Redis plans are [no longer available](https://blog.heroku.com/next-chapter).
+>
+>We recommend using our [low-cost plans](https://blog.heroku.com/new-low-cost-plans) to complete this tutorial. Eligible students can apply for platform credits through our new [Heroku for GitHub Students program](https://blog.heroku.com/github-student-developer-program).
 
 Ruby on Rails is a popular web framework written in [Ruby](http://www.ruby-lang.org/). This guide covers using Rails 4 on Heroku. For information about running previous versions of Rails on Heroku, see [Getting Started with Rails 3.x on Heroku](getting-started-with-rails3).
 
@@ -24,7 +32,8 @@ For this guide you will need:
 - Basic Ruby/Rails knowledge
 - Locally installed version of Ruby 2.0.0+, Rubygems, Bundler, and Rails 4+
 - Basic Git knowledge
-- A Heroku user account: [Signup is free and instant](https://signup.heroku.com/devcenter)
+- A [verified Heroku Account](https://devcenter.heroku.com/articles/account-verification)
+- A subscription to the [Eco dynos plan](eco-dyno-hours) (recommended)
 
 ## Local Workstation Setup
 
@@ -71,14 +80,14 @@ Then create a new app:
 -->
 
 ```term
-$ rails new myapp --database=postgresql
-:::- $ rails _4.2.9_ new myapp --database=postgresql
+$ rails _4.2.9_ new myapp --database=postgresql
+:::-- $ rails _4.2.9_ new myapp --database=postgresql
 ```
 
 Then move into your application directory.
 
 ```term
-:::> $ cd myapp
+:::>- $ cd myapp
 ```
 
 > callout If you experience problems or get stuck with this tutorial, your questions may be answered in a later part of this document. Once you experience a problem try reading through the entire document and then going back to your issue. It can also be useful to review your previous steps to ensure they all executed correctly.
@@ -110,7 +119,7 @@ In addition to using the `pg` gem, you'll also need to ensure the `config/databa
 The development section of your `config/database.yml` file should look something like this:
 
 ```term
-:::>  $ cat config/database.yml
+:::>-  $ cat config/database.yml
 :::>> | $ head -n 23
 ```
 
@@ -122,7 +131,7 @@ Rails 4 no longer has a static index page in production. When you're using a new
 
 
 ```term
-:::> $ rails generate controller welcome
+:::>- $ rails generate controller welcome
 ```
 
 Next we'll add an index page.
@@ -162,7 +171,7 @@ gem 'rails_12factor', group: :production
 Then run:
 
 ```term
-:::> $ bundle install
+:::>- $ bundle install
 ```
 
 We talk more about Rails integration on our [Ruby Support page](https://devcenter.heroku.com/articles/ruby-support#injected-plugins).
@@ -183,7 +192,7 @@ You should also be running the same version of Ruby locally. You can verify by r
 Heroku relies on [git](http://git-scm.com/), a distributed source control managment tool, for deploying your project. If your project is not already in git first verify that `git` is on your system:
 
 ```term
-:::> $ git --help
+:::>- $ git --help
 :::-> | $ head -n 5
 ```
 
@@ -200,9 +209,9 @@ The output should look like this:
 Now run these commands in your Rails app directory to initialize and commit your code to git:
 
 ```term
-:::> $ git init
-:::> $ git add .
-:::> $ git commit -m "init"
+:::>- $ git init
+:::>- $ git add .
+:::>- $ git commit -m "init"
 ```
 
 You can verify everything was committed correctly by running:
@@ -213,33 +222,61 @@ You can verify everything was committed correctly by running:
 
 Now that your application is committed to git you can deploy to Heroku.
 
-## Deploy your application to Heroku
+## Create a Heroku app
+
+>warning
+>Using a dyno and a database to complete this tutorial counts towards your usage. [Delete your app](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-apps-destroy), and [database](https://devcenter.heroku.com/articles/heroku-postgresql#removing-the-add-on) as soon as you're done to control costs.
 
 Make sure you are in the directory that contains your Rails app, then create an app on Heroku:
 
 ```term
-:::>> $ heroku create
+:::>> $ heroku create --stack heroku-20
 ```
 
 You can verify that the remote was added to your project by running
 
 ```term
-:::>> $ git config --list | grep heroku
+:::>> $ git config --list --local | grep heroku
 ```
 
 If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you may deploy your code. After you deploy your code, you will need to migrate your database, make sure it is properly scaled and use logs to debug any issues that come up.
 
+>note
+>Following changes in the industry, Heroku has updated our default git branch name to `main`. If the project you’re deploying uses `master` as its default branch name, use `git push heroku master`.
+
+## Provision a Database
+
+Provision a Postgresql database using Add-ons.
+
+>note
+>A `mini` Postgres size costs [$5 a month, prorated to the minute](https://elements.heroku.com/addons/heroku-postgresql). At the end of this tutorial, you will be prompted to [delete your database](https://devcenter.heroku.com/articles/heroku-postgresql#removing-the-add-on) to minimize costs.
+
+```term
+$ heroku addons:create heroku-postgresql:mini
+Creating heroku-postgresql:mini on ⬢ shrouded-anchorage-34700... $5/month
+Database has been created and is available
+ ! This database is empty. If upgrading, you can transfer
+ ! data from another database with pg:copy
+
+Created postgresql-encircled-75487 as DATABASE_URL
+Use heroku addons:docs heroku-postgresql to view documentation
+```
+
+Your Heroku app now has access to a Postgresql database. The credentials are stored in the `DATABASE_URL` environment variable, which Rails will connect to by convention.
+
+## Deploy your application to Heroku
+
 Deploy your code:
 
 ```term
-:::>> $ git push heroku master
+:::>> $ git push heroku main
 ```
 
 It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.
 
 ## Migrate your database
 
-If you are using the database in your application you need to manually migrate the database by running:
+If you are using the database in your application, trigger a migration by using the Heroku CLI to start a one-off [dyno](dynos), which is a lightweight container that is the basic unit of composition on Heroku, and run `db:migrate`:
 
 ```term
 $ heroku run rake db:migrate
@@ -255,7 +292,7 @@ You've deployed your code to Heroku. You can now instruct Heroku to execute a pr
 Let's ensure we have one dyno running the `web` process type:
 
 ```term
-:::> $ heroku ps:scale web=1
+:::>- $ heroku ps:scale web=1
 ```
 
 You can check the state of the app's dynos. The `heroku ps` command lists the running dynos of your application:
@@ -294,13 +331,13 @@ $ heroku logs --tail
 
 ## Dyno sleeping and scaling
 
-By default, your app is deployed on a free dyno. Free dynos will sleep after a half hour of inactivity and they can be active (receiving traffic) for no more than 18 hours a day before [going to sleep](dynos#dyno-sleeping).  If a free dyno is sleeping, and it hasn't exceeded the 18 hours, any web request will wake it. This causes a delay of a few seconds for the first request upon waking. Subsequent requests will perform normally.
+By default, your app is deployed on an eco dyno. Eco dynos will sleep after a half hour of inactivity and they can be active (receiving traffic) for no more than 18 hours a day before [going to sleep](dynos#dyno-sleeping).  If an eco dyno is sleeping, and it hasn't exceeded the 18 hours, any web request will wake it. This causes a delay of a few seconds for the first request upon waking. Subsequent requests will perform normally.
 
 ```term
 $ heroku ps:scale web=1
 ```
 
-To avoid dyno sleeping, you can upgrade to a hobby or professional dyno type as described in the [Dyno Types](dyno-types) article. For example, if you migrate your app to a professional dyno, you can easily scale it by running a command telling Heroku to execute a specific number of dynos, each running your web process type.
+To avoid dyno sleeping, you can upgrade to a Basic or Professional dyno type as described in the [Dyno Types](dyno-types) article. For example, if you migrate your app to a professional dyno, you can easily scale it by running a command telling Heroku to execute a specific number of dynos, each running your web process type.
 
 ## Console
 
@@ -328,13 +365,13 @@ First, add Puma to your application `Gemfile`:
 
 ```ruby
 :::>> file.append Gemfile
-gem 'puma'
+#gem 'puma'
 ```
 
 Then run
 
 ```term
-:::> $ bundle install
+:::>- $ bundle install
 ```
 
 Now you are ready to configure your app to use Puma. For this tutorial we will use the default settings of Puma, but we recommend generating a `config/puma.rb` file and reading more about configuring your application for maximum performance by [reading the Puma documentation](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server)
@@ -366,15 +403,15 @@ Set the `RACK_ENV` to development in your environment and a `PORT` to connect to
 You'll also want to add `.env` to your `.gitignore` since this is for local enviroment setup.
 
 ```term
-:::> $ echo ".env" >> .gitignore
-:::> $ git add .gitignore
-:::> $ git commit -m "add .env to .gitignore"
+:::>- $ echo ".env" >> .gitignore
+:::>- $ git add .gitignore
+:::>- $ git commit -m "add .env to .gitignore"
 ```
 
 Test your Procfile locally using Foreman:
 
 ```term
-:::> $ gem install foreman
+:::>- $ gem install foreman
 ```
 
 You can now start your web server by running
@@ -392,9 +429,9 @@ $ foreman start
 Looks good, so press Ctrl-C to exit and you can deploy your changes to Heroku:
 
 ```term
-:::> $ git add .
-:::> $ git commit -m "use puma via procfile"
-:::> $ git push heroku master
+:::>- $ git add .
+:::>- $ git commit -m "use puma via procfile"
+:::>- $ git push heroku main
 ```
 
 Check `ps`, you'll see the web process uses your new command specifying Puma as the web server
@@ -462,6 +499,36 @@ end
 
 Confirm it works locally, then push to Heroku.
 
-## Done
+## Next Steps
+
+Congratulations on deploying a Rails 5 application! To continue exploring, review the following articles next:
+
+* Visit the [Ruby support category](/categories/ruby-support) to learn more about using Ruby and Rails on Heroku.
+* The [Deployment category](/categories/deployment) provides a variety of powerful integrations and features to help streamline and simplify your deployments.
+
+## Deleting your app and Add-on
+
+If you don't need this application and database, you can now remove them from your account. You'll only be charged for the resources you used.
+
+>warning
+>This will remove your add-on you'll lose any data saved in the database.
+
+```term
+$ heroku addons:destroy heroku-postgresql
+```
+
+>warning
+>This will delete your application
+
+```term
+$ heroku apps:destroy
+```
+
+You can confirm that your add-on and app are gone with the commands:
+
+```term
+$ heroku addons --all
+$ heroku apps -all
+```
 
-You now have your first application deployed to Heroku. The next step is to deploy your own application. If you're interested in reading more you can read more about [Ruby on Heroku at the Devcenter](https://devcenter.heroku.com/categories/ruby).
+You're now ready to <a href= "https://devcenter.heroku.com/articles/preparing-a-codebase-for-heroku-deployment" target= "_blank">deploy your app</a>.

data/test/fixtures/rails_5/rundoc.md

@@ -9,23 +9,35 @@ end
 ```
 <!--
   rundoc src:
-  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_5/rundoc.md
+  https://github.com/schneems/rundoc/blob/main/test/fixtures/rails_5/rundoc.md
 
   Command:
   $ bin/rundoc build --path test/fixtures/rails_5/rundoc.md
 -->
 
+> warning
+> This article is archived. It is no longer receiving updates. It is presented here for historical reference only.
+> We cannot guarantee that any statements made are correct or that the instructions will still work.
+> This version of Rails is [no longer supported by Ruby core](https://guides.rubyonrails.org/maintenance_policy.html).
+> If you are starting a new application, we recommend you use the most recently released version of Rails.
+
+>warning
+>As of November 28th, 2022, free Heroku dynos, free Heroku Postgres and free Heroku Data for Redis plans are [no longer available](https://blog.heroku.com/next-chapter).
+>
+>We recommend using our [low-cost plans](https://blog.heroku.com/new-low-cost-plans) to complete this tutorial. Eligible students can apply for platform credits through our new [Heroku for GitHub Students program](https://blog.heroku.com/github-student-developer-program).
+
 Ruby on Rails is a popular web framework written in [Ruby](http://www.ruby-lang.org/). This guide covers using Rails 5 on Heroku. For information on running previous versions of Rails on Heroku, see the tutorial for [Rails 4.x](getting-started-with-rails4) or [Rails 3.x](getting-started-with-rails3).
 
 ```
-:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.3'"
+:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.7.8'"
 ```
 
 For this guide you will need:
 
 - Basic familiarity with Ruby/Rails and Git
 - A locally installed version of Ruby 2.2.0+, Rubygems, Bundler, and Rails 5+
-- A Heroku user account: [Signup is free and instant](https://signup.heroku.com/devcenter).
+- A [verified Heroku Account](https://devcenter.heroku.com/articles/account-verification)
+- A subscription to the [Eco dynos plan](eco-dyno-hours) (recommended)
 
 ## Local setup
 
@@ -66,6 +78,8 @@ Then move into your application directory.
 
 ```term
 :::>- $ cd myapp
+:::>> $ bundle lock --add-platform x86_64-linux --add-platform ruby
+:::>- $ bundle install
 ```
 
 Create a database locally:
@@ -164,7 +178,7 @@ Rails 5 requires Ruby 2.2.0 or above. Heroku has a recent version of Ruby instal
 ```ruby
 :::-- $ sed -i'' -e '/^ruby/d' ./Gemfile
 :::-> file.append Gemfile#4
-ruby "2.6.3"
+ruby "2.7.8"
 ```
 
 You should also be running the same version of Ruby locally. You can check this by running `$ ruby -v`. You can get more information on [specifying your Ruby version on Heroku here](https://devcenter.heroku.com/articles/ruby-versions).
@@ -204,33 +218,55 @@ You can verify everything was committed correctly by running:
 
 Now that your application is committed to Git you can deploy to Heroku.
 
-## Deploy your application to Heroku
+## Create a Heroku app
+
+>warning
+>Using a dyno and a database to complete this tutorial counts towards your usage. [Delete your app](https://devcenter.heroku.com/articles/heroku-cli-commands#heroku-apps-destroy), and [database](https://devcenter.heroku.com/articles/heroku-postgresql#removing-the-add-on) as soon as you're done to control costs.
 
 Make sure you are in the directory that contains your Rails app, then create an app on Heroku:
 
 ```term
-:::>> $ heroku create
+:::>> $ heroku create --stack heroku-20
 ```
 
 You can verify that the remote was added to your project by running:
 
 ```term
-:::>> $ git config --list | grep heroku
+:::>> $ git config --list --local | grep heroku
 ```
 
 If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you can deploy your code. After you deploy your code, you  need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.
 
+
+>note
+>Following changes in the industry, Heroku has updated our default git branch name to `main`. If the project you’re deploying uses `master` as its default branch name, use `git push heroku master`.
+
+## Provision a Database
+
+Provision a Postgresql database using Add-ons.
+
+>note
+>A `mini` Postgres size costs [$5 a month, prorated to the minute](https://elements.heroku.com/addons/heroku-postgresql). At the end of this tutorial, you will be prompted to [delete your database](https://devcenter.heroku.com/articles/heroku-postgresql#removing-the-add-on) to minimize costs.
+
+```term
+:::>> $ heroku addons:create heroku-postgresql:mini
+```
+
+Your Heroku app now has access to a Postgresql database. The credentials are stored in the `DATABASE_URL` environment variable, which Rails will connect to by convention.
+
+## Deploy your application to Heroku
+
 Deploy your code:
 
 ```term
-:::>> $ git push heroku master
+:::>> $ git push heroku main
 ```
 
 It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.
 
 ## Migrate your database
 
-If you are using the database in your application, you need to manually migrate the database by running:
+If you are using the database in your application, trigger a migration by using the Heroku CLI to start a one-off [dyno](dynos), which is a lightweight container that is the basic unit of composition on Heroku, and run `db:migrate`:
 
 ```term
 $ heroku run rake db:migrate
@@ -284,9 +320,9 @@ $ heroku logs --tail
 
 ## Dyno sleeping and scaling
 
-By default, new applications are deployed to a free dyno. Free apps will "sleep" to conserve resources. You can find more information about this behavior by reading about [free dyno behavior](free-dyno-hours).
+By default, new applications are deployed to an eco dyno. Eco apps will "sleep" to conserve resources. You can find more information about this behavior by reading about [eco dyno behavior](eco-dyno-hours).
 
-To avoid dyno sleeping, you can upgrade to a hobby or professional dyno type as described in the [Dyno Types](dyno-types) article. For example, if you migrate your app to a professional dyno, you can easily scale it by running a command telling Heroku to execute a specific number of dynos, each running your web process type.
+To avoid dyno sleeping, you can upgrade to a Basic or Professional dyno type as described in the [Dyno Types](dyno-types) article. For example, if you migrate your app to a Professional dyno, you can easily scale it by running a command telling Heroku to execute a specific number of dynos, each running your web process type.
 
 ## Run the Rails console
 
@@ -370,7 +406,7 @@ Looks good, so press `Ctrl+C` to exit and you can deploy your changes to Heroku:
 ```term
 :::>- $ git add .
 :::>- $ git commit -m "use puma via procfile"
-:::>- $ git push heroku master
+:::>- $ git push heroku main
 ```
 
 Check `ps`. You'll see that the web process uses your new command specifying Puma as the web server.
@@ -437,9 +473,36 @@ end
 
 Confirm it works locally, then push to Heroku.
 
-## Next steps
+## Next Steps
 
-Congratulations! You have deployed your first Rails 5 application to Heroku. Here's some recommended reading:
+Congratulations on deploying a Rails 5 application! To continue exploring, review the following articles next:
 
 * Visit the [Ruby support category](/categories/ruby-support) to learn more about using Ruby and Rails on Heroku.
 * The [Deployment category](/categories/deployment) provides a variety of powerful integrations and features to help streamline and simplify your deployments.
+
+## Deleting your app and Add-on
+
+If you don't need this application and database, you can now remove them from your account. You'll only be charged for the resources you used.
+
+>warning
+>This will remove your add-on you'll lose any data saved in the database.
+
+```term
+$ heroku addons:destroy heroku-postgresql
+```
+
+>warning
+>This will delete your application
+
+```term
+$ heroku apps:destroy
+```
+
+You can confirm that your add-on and app are gone with the commands:
+
+```term
+$ heroku addons --all
+$ heroku apps -all
+```
+
+You're now ready to <a href= "https://devcenter.heroku.com/articles/preparing-a-codebase-for-heroku-deployment" target= "_blank">deploy your app</a>.