diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-02-27 15:55:00 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-02-27 15:55:00 -0700 |
| commit | 6db8161a6818d68c106a0d9812d5bd1bda30661c (patch) | |
| tree | f54a21a208b3c5a5d9d2f5b3a6bb027e5ed2362c | |
| parent | 481228b7afd8fcaebb3298fac50ef7849f16f82d (diff) | |
prepare branch to be renamed from master to main
| -rw-r--r-- | .github/workflows/ci.yml | 4 | ||||
| -rw-r--r-- | .github/workflows/upstream-dispatch.yml | 2 | ||||
| -rw-r--r-- | CHANGELOG.adoc | 2 | ||||
| -rw-r--r-- | CONTRIBUTING-CODE.adoc | 4 | ||||
| -rw-r--r-- | CONTRIBUTING.adoc | 2 | ||||
| -rw-r--r-- | README.adoc | 2 | ||||
| -rw-r--r-- | asciidoctor-pdf.gemspec | 4 | ||||
| -rw-r--r-- | docs/theming-guide.adoc | 11 | ||||
| -rw-r--r-- | scripts/switch-to-asciidoctor-head.rb (renamed from scripts/switch-to-asciidoctor-master.rb) | 0 | ||||
| -rw-r--r-- | scripts/switch-to-prawn-head.rb (renamed from scripts/switch-to-prawn-master.rb) | 0 | ||||
| -rw-r--r-- | spec/link_spec.rb | 2 |
11 files changed, 17 insertions, 16 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9ea377e9..d01de21e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -105,8 +105,8 @@ jobs: - name: Switch to upstream dependencies if: matrix.upstream run: | - bundle exec ruby scripts/switch-to-asciidoctor-master.rb - bundle exec ruby scripts/switch-to-prawn-master.rb + bundle exec ruby scripts/switch-to-asciidoctor-head.rb + bundle exec ruby scripts/switch-to-prawn-head.rb rm -f Gemfile.lock bundle config --local clean true bundle --jobs 3 --retry 3 diff --git a/.github/workflows/upstream-dispatch.yml b/.github/workflows/upstream-dispatch.yml index a21e0174..2028727c 100644 --- a/.github/workflows/upstream-dispatch.yml +++ b/.github/workflows/upstream-dispatch.yml @@ -27,7 +27,7 @@ jobs: run: | bundle --jobs 3 --retry 3 # FIXME: should switch to branch specified in payload - bundle exec ruby scripts/switch-to-asciidoctor-master.rb + bundle exec ruby scripts/switch-to-asciidoctor-head.rb rm -f Gemfile.lock bundle --jobs 3 --retry 3 - name: Run tests diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 35c35911..3d634c86 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -3,7 +3,7 @@ :uri-repo: https://github.com/asciidoctor/asciidoctor-pdf This document provides a high-level view of the changes to the {project-name} by release. -For a detailed view of what has changed, refer to the {uri-repo}/commits/master[commit history] on GitHub. +For a detailed view of what has changed, refer to the {uri-repo}/commits/main[commit history] on GitHub. == Unreleased diff --git a/CONTRIBUTING-CODE.adoc b/CONTRIBUTING-CODE.adoc index 08114bdd..1c631b5c 100644 --- a/CONTRIBUTING-CODE.adoc +++ b/CONTRIBUTING-CODE.adoc @@ -195,9 +195,9 @@ Now you can run the application as modified by the PR: $ bundle exec asciidoctor-pdf /path/to/sample.adoc -To switch back to master, just type: +To switch back to main just type: - $ git checkout master + $ git checkout main ==== In Your Application diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 1a6df4c2..b119c8eb 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -37,7 +37,7 @@ Here are just a few of the ways you can contribute to the project: * Writing, editing or maintaining the documentation * Organizing the content (information architecture & content strategy) * Using or extending the software in a creative way -* Testing a prerelease, a pull request or master +* Testing a prerelease, a pull request, the development branch * Reviewing or providing feedback on pull requests * Writing code (_No patch is too small!_) ** Fixing typos diff --git a/README.adoc b/README.adoc index 17285cb7..d68f1005 100644 --- a/README.adoc +++ b/README.adoc @@ -38,7 +38,7 @@ endif::[] :url-graphicsmagick: http://www.graphicsmagick.org ifdef::status[] -image:{url-project-repo}/workflows/CI/badge.svg[Build Status (GitHub Actions),link={url-project-repo}/actions?query=workflow%3ACI+branch%3Amaster] +image:{url-project-repo}/workflows/CI/badge.svg[Build Status (GitHub Actions),link={url-project-repo}/actions?query=workflow%3ACI+branch%3Amain] image:https://img.shields.io/gem/v/asciidoctor-pdf.svg[Latest Release, link={url-gem}] endif::[] diff --git a/asciidoctor-pdf.gemspec b/asciidoctor-pdf.gemspec index 727aaeb9..18c33e82 100644 --- a/asciidoctor-pdf.gemspec +++ b/asciidoctor-pdf.gemspec @@ -17,7 +17,7 @@ Gem::Specification.new do |s| #s.required_ruby_version = '>= 2.5.0' s.metadata = { 'bug_tracker_uri' => 'https://github.com/asciidoctor/asciidoctor-pdf/issues', - 'changelog_uri' => 'https://github.com/asciidoctor/asciidoctor-pdf/blob/master/CHANGELOG.adoc', + 'changelog_uri' => 'https://github.com/asciidoctor/asciidoctor-pdf/blob/main/CHANGELOG.adoc', 'mailing_list_uri' => 'http://discuss.asciidoctor.org', 'source_code_uri' => 'https://github.com/asciidoctor/asciidoctor-pdf' } @@ -35,7 +35,7 @@ Gem::Specification.new do |s| s.add_runtime_dependency 'asciidoctor', '~> 2.0' s.add_runtime_dependency 'prawn', '~> 2.4.0' - # NOTE must use prawn-table from master branch (defined in Gemfile) for full functionality + # NOTE must use prawn-table from head (defined in Gemfile) for full functionality s.add_runtime_dependency 'prawn-table', '~> 0.2.0' s.add_runtime_dependency 'prawn-templates', '~> 0.1.0' s.add_runtime_dependency 'prawn-svg', '~> 0.31.0' diff --git a/docs/theming-guide.adoc b/docs/theming-guide.adoc index b0356ee5..dd52136e 100644 --- a/docs/theming-guide.adoc +++ b/docs/theming-guide.adoc @@ -19,6 +19,7 @@ endif::[] // Aliases: :conum-guard-yaml: # ifdef::backend-pdf[:conum-guard-yaml: # #] +:url-repo-root: https://github.com/asciidoctor/asciidoctor-pdf/tree/main :url-fontforge: https://fontforge.github.io/en-US/ :url-fontforge-scripting: https://fontforge.github.io/en-US/documentation/scripting/ :url-prawn: http://prawnpdf.org @@ -147,7 +148,7 @@ Otherwise, Asciidoctor PDF will use built-in AFM fonts, which can result in miss [TIP] ==== -Instead of creating a theme from scratch, another option is to download the https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml[default-theme.yml] file from the source repository. +Instead of creating a theme from scratch, another option is to download the {url-repo-root}/data/themes/default-theme.yml[default-theme.yml] file from the source repository. Save the file using a unique name (e.g., _custom-theme.yml_) and start hacking on it. Alternatively, you can snag the file from your local installation using the following command: @@ -608,7 +609,7 @@ The following image types (and corresponding file extensions) are supported: * SVG (.svg) CAUTION: The GIF format (.gif) and BMP format (.bmp) are not supported unless you're using prawn-gmagick. -See https://github.com/asciidoctor/asciidoctor-pdf#supporting-additional-image-file-formats[support for additional image file formats] for details. +See {url-repo-root}/README.adoc#supporting-additional-image-file-formats[support for additional image file formats] for details. Here's how an image is specified in the theme file as a bare image path: @@ -1014,9 +1015,9 @@ This nested structure is for organizational purposes only. All keys are flatted when the theme is loaded (e.g., `align` nested under `base` becomes `base-align`). The converter uses the values of these keys to control how most elements are arranged and styled in the PDF. -The default values listed in this section get inherited from the https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/base-theme.yml[base theme]. +The default values listed in this section get inherited from the {url-repo-root}/data/themes/base-theme.yml[base theme]. -IMPORTANT: The https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml[default theme] has a different set of values which are not shown in this guide. +IMPORTANT: The {url-repo-root}/data/themes/default-theme.yml[default theme] has a different set of values which are not shown in this guide. When creating a theme that extends the base theme, all keys are optional. Required keys are provided by the base theme. @@ -5975,5 +5976,5 @@ Performing all this font modification manually can be tedious (not to mention ha Fortunately, FontForge provides a {url-fontforge-scripting}[scripting interface], which you can use to automate the process. In fact, that's what we use to prepare the fonts that are bundled with Asciidoctor PDF. -You can find that FontForge script, the Bash script that calls it, and the Docker image in which it is run in the https://github.com/asciidoctor/asciidoctor-pdf/tree/master/scripts[scripts directory] of this project. +You can find that FontForge script, the Bash script that calls it, and the Docker image in which it is run in the {url-repo-root}/scripts[scripts directory] of this project. You can use that script as a starting point or reference for your own font preparation / modification script. diff --git a/scripts/switch-to-asciidoctor-master.rb b/scripts/switch-to-asciidoctor-head.rb index 7ea519bc..7ea519bc 100644 --- a/scripts/switch-to-asciidoctor-master.rb +++ b/scripts/switch-to-asciidoctor-head.rb diff --git a/scripts/switch-to-prawn-master.rb b/scripts/switch-to-prawn-head.rb index 438e1021..438e1021 100644 --- a/scripts/switch-to-prawn-master.rb +++ b/scripts/switch-to-prawn-head.rb diff --git a/spec/link_spec.rb b/spec/link_spec.rb index 32a1ab53..17372f35 100644 --- a/spec/link_spec.rb +++ b/spec/link_spec.rb @@ -50,7 +50,7 @@ describe 'Asciidoctor::PDF::Converter - Link' do end it 'should not encode hash that precedes the fragment in a URL' do - url_with_hash = 'https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc#fonts' + url_with_hash = 'https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/theming-guide.adoc#fonts' pdf = to_pdf %(Learn how to configure #{url_with_hash}[].) text = (pdf.page 1).text (expect text).to eql %(Learn how to configure #{url_with_hash.sub 'theming-guide', "theming-\nguide"}.) |
