Merge pull request #19 from progit/refactor/progit2

Author: YasinDehfuli

.dependabot/config.yml

@@ -0,0 +1,131 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["bug"]
+body:
+  - type: checkboxes
+    attributes:
+      label: There's no existing/similar bug report.
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+
+  - type: checkboxes
+    attributes:
+      label: This report is about a single actionable bug.
+      description: Please create one issue per bug, split up your bug reports if needed.
+      options:
+        - label: I'm reporting a single actionable bug
+          required: true
+
+  - type: checkboxes
+    attributes:
+      label: This report is about the ProGit book, version 2, English language.
+      description: Bug reports about translations or the first version of the book are not accepted.
+      options:
+        - label: This bug is not about a translation or old version
+          required: true
+
+  - type: checkboxes
+    attributes:
+      label: Bug covers book website/pdf
+      description: This bug is about the book as found on the [website](https://www.git-scm.com/book/en/v2) or the PDF.
+      options:
+        - label: I confirm the bug is about the book as found on the website/pdf
+    validations:
+      required: false
+
+  - type: checkboxes
+    attributes:
+      label: Problem is present in the Pro Git book on the website?
+      description: If you found an issue in the pdf/epub/mobi files, you've checked if the problem is also present in the Pro Git book on the [website](https://www.git-scm.com/book/en/v2).
+      options:
+        - label: This bug also affects the Pro Git book as published on the website.
+    validations:
+      required: false
+
+  - type: dropdown
+    attributes:
+      label: Which version of the book is affected?
+      description: |
+        It's important for us to know if the problem is in the source or in the tooling that creates the pdf/epub/mobi files.
+        Therefore, please select which versions are affected.
+      options:
+        - "Source files"
+        - "Tooling"
+        - "Source files and tooling"
+        - "I don't know"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Describe the bug:"
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Steps to reproduce:"
+      description: Please write the steps needed to reproduce the bug here.
+      placeholder: Provide a ordered list of steps to reproduce.
+      value: |
+        1. Go to '...'
+        2. Click on '...'
+        3. 'Scroll down to '...'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Expected behavior:"
+      description: A clear and concise description of what you expected to happen.
+      placeholder: I expected ... to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Screenshots:"
+      description: If applicable, add screenshots to help explain your problem.
+      placeholder: "Tip: you can drag your screenshot into this field, or you can copy/paste."
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: "Additional context:"
+      description: |
+        Add any other context about the problem here.
+        You can also put references to similar bugs here.
+      placeholder: "Example: this bug also affect issues #1 and #2."
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Device
+      description: Tell us what kind of device you're using to access the content.
+      placeholder: mobile device / desktop / laptop / e-book reader
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Operating system
+      description: If the problem is with the book or the published files, we need to know what operating system you run on your device.
+      placeholder: |
+        Windows 10 Home Edition
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Browser/application + version
+      description: What browser/application are you using? We also need the version number of the browser/application.
+      placeholder: |
+        Google Chrome 91.0.4472.164
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Translation bug
+    url: https://github.com/progit/progit2/blob/main/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 there.
+
+  - name: Bug is about Git program itself
+    url: https://git-scm.com/community
+    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 there.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,34 @@
+name: Enhancement idea
+description: Suggest an idea for the ProGit2 book or repository
+labels: ["enhancement"]
+body:
+  - type: textarea
+    attributes:
+      label: General overview of your idea.
+      description: Give a general overview of your idea.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What problem will this solve?
+      description: Explain what problem you're trying to solve.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Have you thought about other solutions?
+      description: Describe any alternative solutions to the problem.
+    validations:
+      required: false
+
+  - type: dropdown
+    attributes:
+      label: Do you want to help with this enhancement idea?
+      options:
+        - "Yes"
+        - "Maybe"
+        - "No"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  # Maintain dependencies for Ruby
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily" # Checks on Monday through Friday.
+
+  # Maintain GitHub Action runners
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily" # Checks on Monday through Friday.
+
+    # Set default reviewer and labels
+    reviewers:
+      - "ben"
+    labels:
+      - "dependabot"

.github/ISSUE_TEMPLATE/enhancement_idea.yml

@@ -0,0 +1,23 @@
+<!-- Thanks for contributing! -->
+<!-- Before you start on a large rewrite or other major change: open a new issue first, to discuss the proposed changes. -->
+<!-- Should your changes appear in a printed edition, you'll be included in the contributors list. -->
+
+<!-- Mark the checkbox [X] or [x] if you agree with the item. -->
+- [ ] I provide my work under the [project license](https://github.com/progit/progit2/blob/main/LICENSE.asc).
+- [ ] I grant such license of my work as is required for the purposes of future print editions to [Ben Straub](https://github.com/ben) and [Scott Chacon](https://github.com/schacon).
+
+## Changes
+
+- 
+
+## Context
+<!--
+List related issues.
+Provide the necessary context to understand the changes you made.
+
+Are you fixing an issue with this pull-request?
+Use the "Fixes" keyword, to close the issue automatically after your work is merged.
+
+Fixes #123
+Fixes #456
+-->

.github/dependabot.yml

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

.github/pull_request_template.md

@@ -0,0 +1,38 @@
+name: Release on push to main
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Build release assets
+      run: bundle exec rake book:build
+
+    - 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 "tagname=2.1.${PATCH}" >> $GITHUB_OUTPUT
+
+    - name: Create release
+      uses: ncipollo/release-action@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        tag: ${{ steps.compute-tag.outputs.tagname }}
+        commit: main
+        artifacts: './progit.epub,./progit.fb2.zip,./progit.mobi,./progit.pdf,./progit.html'