From b237da9761beb76df29e5eb2569ddeafdceba939 Mon Sep 17 00:00:00 2001 From: Abel Salgado Romero Date: Sat, 10 Apr 2021 12:12:37 +0200 Subject: [PATCH] Rename main branch to 'main' --- .github/workflows/build-publish-docs.yaml | 4 ++-- .github/workflows/build.yaml | 6 +++--- CHANGELOG.adoc | 5 +++-- README.adoc | 12 ++++++------ README_zh-CN.adoc | 8 ++++---- antora-playbook.yml | 6 +++--- .../partials/process-asciidoc-mojo-parameters.adoc | 2 +- .../modules/project/pages/copyright-and-licence.adoc | 2 +- .../maven/AsciidoctorMojoExtensionsTest.java | 2 +- .../errors/document-with-missing-include.adoc | 4 ++-- .../resources/src/asciidoctor/processors-sample.adoc | 2 +- 11 files changed, 27 insertions(+), 26 deletions(-) diff --git a/.github/workflows/build-publish-docs.yaml b/.github/workflows/build-publish-docs.yaml index 551b40e2..d063fde2 100644 --- a/.github/workflows/build-publish-docs.yaml +++ b/.github/workflows/build-publish-docs.yaml @@ -2,7 +2,7 @@ name: Build & publish docs on: push: branches: - - master + - main env: SITE_DIR: 'site' @@ -46,4 +46,4 @@ jobs: FOLDER: "${{ env.SITE_DIR }}" BRANCH: 'gh-pages' COMMIT_MESSAGE: "[CI] Publish Documentation for ${{ github.sha }}" - CLEAN: true \ No newline at end of file + CLEAN: true diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 4b44d368..bbe45a08 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -2,10 +2,10 @@ name: Build on: push: branches: - - master + - main pull_request: branches: - - master + - main jobs: build: @@ -36,4 +36,4 @@ jobs: key: ${{ runner.os }}-mvn-cache-${{ hashFiles('**/pom.xml') }} restore-keys: ${{ runner.os }}-mvn-cache- - name: Build - run: ./mvnw -B -V -Prun-its clean verify \ No newline at end of file + run: ./mvnw -B -V -Prun-its clean verify diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 67cfe24f..19d6bb8a 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -9,7 +9,7 @@ ifndef::icons[] endif::[] This document provides a high-level view of the changes introduced on Asciidoctor Maven Plugin 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 @@ -18,7 +18,7 @@ Documentation:: * Migrate docs (README) to Antora site and publish them in gh-pages (#498) * Remove ambiguity in usage of maven properties docs (#507) * Add ID to 'attributes' description, to be able to generate direct url from other docs (#509) - * Fix broken links to extension api documentation (#523). + * Fix broken links to extension api documentation (https://github.com/djarnis73[@djarnis73]) (#523) Maintenance:: @@ -30,6 +30,7 @@ Maintenance:: * Rewrite `AsciidoctorZipMojoTest` to Java to make it more approachable (#518) * Rewrite `AsciidoctorDoxiaParserTest` to Java + remove Groovy & Spock configurations (#519) * Upgrade tests to JUni5 (#521) + * Rename main branch (#524) == v2.1.0 (2020-09-15) diff --git a/README.adoc b/README.adoc index 502eea42..122a0792 100644 --- a/README.adoc +++ b/README.adoc @@ -17,12 +17,12 @@ ifndef::env-github[:icons: font] :uri-asciidoctor: http://asciidoctor.org :uri-examples: https://github.com/asciidoctor/asciidoctor-maven-examples :uri-maven: http://maven.apache.org -:uri-license: {uri-repo}/blob/master/LICENSE.txt +:uri-license: {uri-repo}/blob/main/LICENSE.txt :uri-docs: https://asciidoctor.github.io/asciidoctor-maven-plugin/maven-tools/{docs-version} // GitHub customization ifdef::env-github[] :badges: -:tag: master +:tag: main :!toc-title: :tip-caption: :bulb: :note-caption: :paperclip: @@ -33,10 +33,10 @@ endif::[] // Badges ifdef::badges[] -image:https://ci.appveyor.com/api/projects/status/chebmu91f08dlmsc/branch/master?svg=true["Build Status (AppVeyor)", link="https://ci.appveyor.com/project/asciidoctor/asciidoctor-maven-plugin"] -image:http://img.shields.io/travis/asciidoctor/asciidoctor-maven-plugin/master.svg["Build Status (Travis CI)", link="https://travis-ci.org/asciidoctor/asciidoctor-maven-plugin"] +image:https://ci.appveyor.com/api/projects/status/chebmu91f08dlmsc/branch/main?svg=true["Build Status (AppVeyor)", link="https://ci.appveyor.com/project/asciidoctor/asciidoctor-maven-plugin"] +image:http://img.shields.io/travis/asciidoctor/asciidoctor-maven-plugin/main.svg["Build Status (Travis CI)", link="https://travis-ci.org/asciidoctor/asciidoctor-maven-plugin"] image:{uri-repo}/workflows/Build/badge.svg[Build Status,link={uri-repo}/actions] -image:http://img.shields.io/coveralls/{project-repo}/master.svg["Coverage Status", link="https://coveralls.io/r/{project-repo}?branch=master"] +image:http://img.shields.io/coveralls/{project-repo}/main.svg["Coverage Status", link="https://coveralls.io/r/{project-repo}?branch=main"] image:https://maven-badges.herokuapp.com/maven-central/org.asciidoctor/asciidoctor-maven-plugin/badge.svg["Maven Central",link="https://maven-badges.herokuapp.com/maven-central/org.asciidoctor/asciidoctor-maven-plugin"] image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[project chat,link=https://asciidoctor.zulipchat.com/] endif::[] @@ -57,7 +57,7 @@ ifndef::env-site[] * link:README_zh-CN.adoc[汉语] endif::[] -ifeval::['{tag}' == 'master'] +ifeval::['{tag}' == 'main'] [NOTE] ==== You're viewing the documentation for the upcoming release. diff --git a/README_zh-CN.adoc b/README_zh-CN.adoc index ebfe9867..1b8c1d2d 100644 --- a/README_zh-CN.adoc +++ b/README_zh-CN.adoc @@ -17,7 +17,7 @@ ifdef::env-github[:badges:] :uri-maven: http://maven.apache.org // GitHub customization ifdef::env-github[] -:tag: master +:tag: main :!toc-title: :tip-caption: :bulb: :note-caption: :paperclip: @@ -27,9 +27,9 @@ ifdef::env-github[] endif::[] // Badges ifdef::badges[] -image:https://ci.appveyor.com/api/projects/status/chebmu91f08dlmsc/branch/master?svg=true["Build Status (AppVeyor)", link="https://ci.appveyor.com/project/asciidoctor/asciidoctor-maven-plugin"] -image:http://img.shields.io/travis/asciidoctor/asciidoctor-maven-plugin/master.svg["Build Status (Travis CI)", link="https://travis-ci.org/asciidoctor/asciidoctor-maven-plugin"] -image:http://img.shields.io/coveralls/{project-repo}/master.svg["Coverage Status", link="https://coveralls.io/r/{project-repo}?branch=master"] +image:https://ci.appveyor.com/api/projects/status/chebmu91f08dlmsc/branch/main?svg=true["Build Status (AppVeyor)", link="https://ci.appveyor.com/project/asciidoctor/asciidoctor-maven-plugin"] +image:http://img.shields.io/travis/asciidoctor/asciidoctor-maven-plugin/main.svg["Build Status (Travis CI)", link="https://travis-ci.org/asciidoctor/asciidoctor-maven-plugin"] +image:http://img.shields.io/coveralls/{project-repo}/main.svg["Coverage Status", link="https://coveralls.io/r/{project-repo}?branch=main"] image:https://maven-badges.herokuapp.com/maven-central/org.asciidoctor/asciidoctor-maven-plugin/badge.svg["Maven Central",link="https://maven-badges.herokuapp.com/maven-central/org.asciidoctor/asciidoctor-maven-plugin"] endif::[] diff --git a/antora-playbook.yml b/antora-playbook.yml index 3bf61f1b..0ecda4c9 100644 --- a/antora-playbook.yml +++ b/antora-playbook.yml @@ -3,7 +3,7 @@ site: content: sources: - url: . - branches: [ master ] + branches: [ main ] start_path: docs asciidoc: attributes: @@ -12,10 +12,10 @@ asciidoc: idseparator: '-' ui: bundle: - url: https://github.com/abelsromero/asciidoctor-maven-plugin-antora-ui/raw/master/bundle/ui-bundle.zip + url: https://github.com/abelsromero/asciidoctor-maven-plugin-antora-ui/raw/main/bundle/ui-bundle.zip snapshot: true supplemental_files: - path: ui.yml contents: | static_files: [ .nojekyll ] - - path: .nojekyll \ No newline at end of file + - path: .nojekyll diff --git a/docs/modules/plugin/partials/process-asciidoc-mojo-parameters.adoc b/docs/modules/plugin/partials/process-asciidoc-mojo-parameters.adoc index 0ded8b3f..a2c59f91 100644 --- a/docs/modules/plugin/partials/process-asciidoc-mojo-parameters.adoc +++ b/docs/modules/plugin/partials/process-asciidoc-mojo-parameters.adoc @@ -6,7 +6,7 @@ When a custom value is set, no other paths are checked. ==== All paths and AsciiDoc documents that start with `pass:[_]` are considered _internal_ and are skipped. That is, AsciiDocs are not converted and resources are not copied from them, but you can include them normally from other AsciiDocs. + -This is useful to split your sources in sets of master documents and included parts. +This is useful to split your sources in sets of main documents and included parts. ==== sourceDocumentName:: an override to process a single source file; defaults to all files in [.path]`$\{sourceDirectory}`. diff --git a/docs/modules/project/pages/copyright-and-licence.adoc b/docs/modules/project/pages/copyright-and-licence.adoc index 47e4f8b0..1129715b 100644 --- a/docs/modules/project/pages/copyright-and-licence.adoc +++ b/docs/modules/project/pages/copyright-and-licence.adoc @@ -1,5 +1,5 @@ == Copyright and License -:uri-license: https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/master/LICENSE.txt +:uri-license: https://github.com/asciidoctor/asciidoctor-maven-plugin/blob/main/LICENSE.txt Copyright (C) 2013-2020 Jason Porter, Dan Allen, Abel Salgado Romero and the individual contributors. Use of this software is granted under the terms of the Apache License, Version 2.0. diff --git a/src/test/java/org/asciidoctor/maven/AsciidoctorMojoExtensionsTest.java b/src/test/java/org/asciidoctor/maven/AsciidoctorMojoExtensionsTest.java index 1bbe489d..9e27e807 100644 --- a/src/test/java/org/asciidoctor/maven/AsciidoctorMojoExtensionsTest.java +++ b/src/test/java/org/asciidoctor/maven/AsciidoctorMojoExtensionsTest.java @@ -23,7 +23,7 @@ * Specific tests to validate usage of AsciidoctorJ extension in AsciidoctorMojo. * * Most of the examples have been directly adapted from the ones found in AsciidoctorJ - * documentation (https://github.com/asciidoctor/asciidoctorj/blob/master/README.adoc) + * documentation. * * @author abelsromero */ diff --git a/src/test/resources/src/asciidoctor/errors/document-with-missing-include.adoc b/src/test/resources/src/asciidoctor/errors/document-with-missing-include.adoc index 7c90fadc..b92ff38d 100644 --- a/src/test/resources/src/asciidoctor/errors/document-with-missing-include.adoc +++ b/src/test/resources/src/asciidoctor/errors/document-with-missing-include.adoc @@ -4,7 +4,7 @@ include::unexistingdoc.adoc[] include::unexistingdoc.adoc[] -include::https://raw.githubusercontent.com/asciidoctor/asciidoctor-maven-plugin/master/src/test/resources/src/asciidoctor/github-include.adoc[] +include::https://raw.githubusercontent.com/asciidoctor/asciidoctor-maven-plugin/main/src/test/resources/src/asciidoctor/github-include.adoc[] include::unexistingdoc.adoc[] @@ -22,4 +22,4 @@ public class HelloWorld { } ---- -<1> Missing callout reference? \ No newline at end of file +<1> Missing callout reference? diff --git a/src/test/resources/src/asciidoctor/processors-sample.adoc b/src/test/resources/src/asciidoctor/processors-sample.adoc index 31a25d43..c3b2adc1 100644 --- a/src/test/resources/src/asciidoctor/processors-sample.adoc +++ b/src/test/resources/src/asciidoctor/processors-sample.adoc @@ -50,4 +50,4 @@ The time is now. Get a move on. include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/Gemfile[] ---- -Created by {author} \ No newline at end of file +Created by {author}