Merge branch 'progit:master' into chore/update-link-in-readme

Author: HonkingGoose

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: "bug"
+assignees: ""
 ---
 
 <!-- Before filing a bug please check the following: -->

.github/ISSUE_TEMPLATE/config.yml

@@ -1,16 +1,17 @@
+blank_issues_enabled: false
 contact_links:
   - name: Translation bug
     url: https://github.com/progit/progit2/blob/master/TRANSLATING.md
     about: Refer to this table to find out where to report translation bugs.
 
   - name: Report bugs for git-scm.com site
     url: https://github.com/git/git-scm.com/issues/
-    about: Please report problems with the git-scm.com site here.
+    about: Please report problems with the git-scm.com site there.
 
   - name: Bug is about Git program itself
     url: https://git-scm.com/community
-    about: Please report problems with the Git program here.
+    about: Please report problems with the Git program there.
 
   - name: Bug is about Git for Windows
     url: https://github.com/git-for-windows/git/issues
-    about: Please report problems with Git for Windows here.
+    about: Please report problems with Git for Windows there.

.github/ISSUE_TEMPLATE/enhancement_idea.md

@@ -0,0 +1,15 @@
+---
+name: Enhancement idea
+about: Suggest an idea for the ProGit2 book or repository
+title: ""
+labels: "enhancement"
+assignees: ""
+---
+
+**Give a general overview of your idea.**
+
+**Explain what problem you're trying to solve.**
+
+**Have you thought about other solutions?**
+
+**Do you want to help with this enhancement idea?**

.github/dependabot.yml

@@ -6,6 +6,12 @@ updates:
     schedule:
       interval: "daily" # Checks on Monday trough Friday.
 
+  # Maintain GitHub Action runners
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily" # Checks on Monday trough Friday.
+
     # Set default reviewer and labels
     reviewers:
       - "ben"

.github/workflows/pr-build.yml

@@ -0,0 +1,20 @@
+name: Pull Request Build
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Build book
+      run: bundle exec rake book:build

.github/workflows/release-on-merge.yml

@@ -0,0 +1,38 @@
+name: Release on push to master
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Compute tag name
+      id: compute-tag
+      run: |
+        echo Computing next tag number
+        LASTPATCH=$(git describe --tags | cut -d- -f1 | cut -d. -f3)
+        PATCH=$(($LASTPATCH+1))
+        echo "::set-output name=tagname::2.1.${PATCH}"
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Build release assets
+      run: bundle exec rake book:build
+
+    - name: Create release
+      uses: ncipollo/release-action@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        tag: ${{ steps.compute-tag.outputs.tagname }}
+        commit: master
+        artifacts: './progit.epub,./progit.mobi,./progit.pdf,./progit.html'

.travis.yml

@@ -6,11 +6,11 @@ gem 'asciidoctor', '2.0.15'
 gem 'json', '2.5.1'
 gem 'awesome_print', '1.9.2'
 
-gem 'asciidoctor-epub3', '1.5.0.alpha.19'
-gem 'asciidoctor-pdf', '1.5.4'
+gem 'asciidoctor-epub3', '1.5.1'
+gem 'asciidoctor-pdf', '1.6.0'
 
 gem 'coderay', '1.1.3'
 gem 'pygments.rb', '2.2.0'
 gem 'thread_safe', '0.3.6'
 gem 'epubcheck-ruby', '4.2.5.0'
-gem 'html-proofer', '3.19.0'
+gem 'html-proofer', '3.19.2'

Gemfile

@@ -15,8 +15,7 @@ See link:TRANSLATING.md[the translating document] for more information.
 == How To Generate the Book
 
 You can generate the e-book files manually with Asciidoctor.
-We used to be able to build .mobi files (Kindle), but cannot do so now, see #1496 for more information.
-If you run the following you _may_ actually get HTML, Epub and PDF output files:
+If you run the following you _may_ actually get HTML, Epub, Mobi and PDF output files:
 
 ----
 $ bundle install
@@ -25,11 +24,13 @@ Converting to HTML...
  -- HTML output at progit.html
 Converting to EPub...
  -- Epub output at progit.epub
+Converting to Mobi (kf8)...
+ -- Mobi output at progit.mobi
 Converting to PDF...
  -- PDF output at progit.pdf
 ----
 
-You can generate just one of the supported formats (HTML, EPUB, or PDF).
+You can generate just one of the supported formats (HTML, EPUB, mobi, or PDF).
 Use one of the following commands:
 
 To generate the HTML book:
@@ -44,6 +45,12 @@ To generate the EPUB book:
 $ bundle exec rake book:build_epub
 ----
 
+To generate the mobi book:
+
+----
+$ bundle exec rake book:build_mobi
+----
+
 To generate the PDF book:
 
 ----

README.asc

@@ -7,7 +7,7 @@ namespace :book do
   end
 
   # Variables referenced for build
-  version_string = ENV['TRAVIS_TAG'] || `git describe --tags`.chomp
+  version_string = `git describe --tags`.chomp
   if version_string.empty?
     version_string = '0'
   end
@@ -37,7 +37,7 @@ namespace :book do
   end
 
   desc 'build basic book formats'
-  task :build => [:build_html, :build_epub, :build_pdf] do
+  task :build => [:build_html, :build_epub, :build_mobi, :build_pdf] do
     begin
         # Run check
         Rake::Task['book:check'].invoke
@@ -50,7 +50,7 @@ namespace :book do
   end
 
   desc 'build basic book formats (for ci)'
-  task :ci => [:build_html, :build_epub, :build_pdf] do
+  task :ci => [:build_html, :build_epub, :build_mobi, :build_pdf] do
       # Run check, but don't ignore any errors
       Rake::Task['book:check'].invoke
   end
@@ -84,18 +84,11 @@ namespace :book do
 
   desc 'build Mobi format'
   task :build_mobi => 'book/contributors.txt' do
-      # Commented out the .mobi file creation because the kindlegen dependency is not available.
-      # For more information on this see: #1496.
-      # This is a (hopefully) temporary fix until upstream asciidoctor-epub3 is fixed and we can offer .mobi files again.
-
-      # puts "Converting to Mobi (kf8)..."
-      # `bundle exec asciidoctor-epub3 #{params} -a ebook-format=kf8 progit.asc`
-      # puts " -- Mobi output at progit.mobi"
-
-      # FIXME: If asciidoctor-epub3 supports Mobi again, uncomment these lines below
-      puts "Converting to Mobi isn't supported yet."
-      puts "For more information see issue #1496 at https://github.com/progit/progit2/issues/1496."
-      exit(127)
+      check_contrib()
+
+      puts "Converting to Mobi (kf8)..."
+      `bundle exec asciidoctor-epub3 #{params} -a ebook-format=kf8 progit.asc`
+      puts " -- Mobi output at progit.mobi"
   end
 
   desc 'build PDF format'
@@ -120,7 +113,7 @@ namespace :book do
     begin
         puts 'Removing generated files'
 
-        FileList['book/contributors.txt', 'progit.html', 'progit.epub', 'progit.pdf'].each do |file|
+        FileList['book/contributors.txt', 'progit.html', 'progit.epub', 'progit.mobi', 'progit.pdf'].each do |file|
             rm file
 
             # Rescue if file not found

Rakefile

@@ -72,22 +72,13 @@ On https://git-scm.com, the translations are divided into three categories. Once
 | Partial translations available in | up to chapter 6 has been translated. |
 | Full translation available in |the book is (almost) fully translated. |
 
-## Continuous integration with Travis CI
+## Continuous integration with GitHub Actions
 
-Travis CI is a [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) service that integrates with GitHub. Travis CI is used to ensure that a pull-request doesn't break the build or compilation. Travis CI can also provide compiled versions of the book.
+GitHub Actions is a [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) service that integrates with GitHub. GitHub Actions is used to ensure that a pull-request doesn't break the build or compilation. GitHub Actions can also provide compiled versions of the book.
 
-Setting up Travis CI requires administrative control over the repository.
-
-### Registering for Travis continuous integration
-
-1. Register a Travis account [here](https://travis-ci.org/).
-1. Register your project in Travis.
-Please refer to the [Travis documentation](https://docs.travis-ci.com/) for more information.
-
-### Setting up your repository for continuous integration
-
-Travis CI works by scanning your project's root directory for a file named `.travis.yml` and following the 'recipe' that it contains. The good news is: there's already a working `.travis.yml` file in the Pro Git 2 source [here](https://raw.githubusercontent.com/progit/progit2-pub/master/travis.yml).
-Copy that file, and put it in your working directory. Commit the .yml file and push it to your translation repository; that should fire up a compilation and a check of the book's contents.
+The configuration for GitHub Actions is contained in the `.github/workflows` directory, and if you bring in the `master` branch of the root repository you'll get them for free.
+However, if you created your translation repo by _forking_ the root repo, there's an extra step you must complete (if you did not fork, you can skip this part).
+GitHub assumes that forks will be used to contribute to the repo from which they were forked, so you'll have to visit the "Actions" tab on your forked repo, and click the "I understand my workflows" button to allow the actions to run.
 
 ## Setting up a publication chain for e-books
 

TRANSLATING.md

@@ -28,21 +28,23 @@ In addition, if you don't need the full-blown manpage help, but just need a quic
 $ git add -h
 usage: git add [<options>] [--] <pathspec>...
 
-    -n, --dry-run         dry run
-    -v, --verbose         be verbose
-
-    -i, --interactive     interactive picking
-    -p, --patch           select hunks interactively
-    -e, --edit            edit current diff and apply
-    -f, --force           allow adding otherwise ignored files
-    -u, --update          update tracked files
-    --renormalize         renormalize EOL of tracked files (implies -u)
-    -N, --intent-to-add   record only the fact that the path will be added later
-    -A, --all             add changes from all tracked and untracked files
-    --ignore-removal      ignore paths removed in the working tree (same as --no-all)
-    --refresh             don't add, only refresh the index
-    --ignore-errors       just skip files which cannot be added because of errors
-    --ignore-missing      check if - even missing - files are ignored in dry run
-    --chmod (+|-)x        override the executable bit of the listed files
+    -n, --dry-run               dry run
+    -v, --verbose               be verbose
+
+    -i, --interactive           interactive picking
+    -p, --patch                 select hunks interactively
+    -e, --edit                  edit current diff and apply
+    -f, --force                 allow adding otherwise ignored files
+    -u, --update                update tracked files
+    --renormalize               renormalize EOL of tracked files (implies -u)
+    -N, --intent-to-add         record only the fact that the path will be added later
+    -A, --all                   add changes from all tracked and untracked files
+    --ignore-removal            ignore paths removed in the working tree (same as --no-all)
+    --refresh                   don't add, only refresh the index
+    --ignore-errors             just skip files which cannot be added because of errors
+    --ignore-missing            check if - even missing - files are ignored in dry run
+    --chmod (+|-)x              override the executable bit of the listed files
+    --pathspec-from-file <file> read pathspec from file
+    --pathspec-file-nul         with --pathspec-from-file, pathspec elements are separated with NUL character
 ----
 

book/01-introduction/sections/help.asc

@@ -36,7 +36,7 @@ Now Git will use your key by default to sign tags and commits if you want.
 
 ==== Signing Tags
 
-If you have a GPG private key setup, you can now use it to sign new tags.
+If you have a GPG private key set up, you can now use it to sign new tags.
 All you have to do is use `-s` instead of `-a`:
 
 [source,console]

book/07-git-tools/sections/signing.asc

@@ -126,7 +126,7 @@ The next type of Git object we'll examine is the _tree_, which solves the proble
 Git stores content in a manner similar to a UNIX filesystem, but a bit simplified.
 All the content is stored as tree and blob objects, with trees corresponding to UNIX directory entries and blobs corresponding more or less to inodes or file contents.
 A single tree object contains one or more entries, each of which is the SHA-1 hash of a blob or subtree with its associated mode, type, and filename.
-For example, the most recent tree in a project may look something like this:
+For example, let's say you have a project where the most-recent tree looks something like:
 
 [source,console]
 ----

book/10-git-internals/sections/objects.asc

@@ -1,25 +1,19 @@
 === Git in Visual Studio
 
 (((Visual Studio)))
-Starting with Visual Studio 2013 Update 1, Visual Studio users have a Git client built directly into their IDE.
-Visual Studio has had source-control integration features for quite some time, but they were oriented towards centralized, file-locking systems, and Git was not a good match for this workflow.
-Visual Studio 2013's Git support has been separated from this older feature, and the result is a much better fit between Studio and Git.
+Visual Studio has Git tooling built directly into the IDE, starting with Visual Studio 2019 version 16.8.
 
-To locate the feature, open a project that's controlled by Git (or just `git init` an existing project), and select View > Team Explorer from the menu.
-You'll see the "Connect" view, which looks a bit like this:
+The tooling supports the following Git functionality:
 
-.Connecting to a Git repository from Team Explorer
-image::images/vs-1.png[Connecting to a Git repository from Team Explorer]
+* Create or clone a repository.
+* Open and browse history of a repository.
+* Create and checkout branches and tags.
+* Stash, stage, and commit changes.
+* Fetch, pull, push, or sync commits.
+* Merge and rebase branches.
+* Resolve merge conflicts.
+* View diffs.
+* ... and more!
 
-Visual Studio remembers all of the projects you've opened that are Git-controlled, and they're available in the list at the bottom.
-If you don't see the one you want there, click the "Add" link and type in the path to the working directory.
-Double clicking on one of the local Git repositories leads you to the Home view, which looks like <<vs_home>>.
-This is a hub for performing Git actions; when you're _writing_ code, you'll probably spend most of your time in the "Changes" view, but when it comes time to pull down changes made by your teammates, you'll use the "Unsynced Commits" and "Branches" views.
+Read the https://docs.microsoft.com/visualstudio/version-control[official documentation^] to learn more.
 
-[[vs_home]]
-.The "Home" view for a Git repository in Visual Studio
-image::images/vs-2.png[The “Home” view for a Git repository in Visual Studio]
-
-Visual Studio now has a powerful task-focused UI for Git.
-It includes a linear history view, a diff viewer, remote commands, and many other capabilities.
-For more on using Git within Visual Studio go to: https://docs.microsoft.com/en-us/azure/devops/repos/git/command-prompt?view=azure-devops[].