summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorrtk0c <[email protected]>2025-09-01 11:27:12 -0700
committerrtk0c <[email protected]>2025-09-01 11:27:12 -0700
commit86b0d0c422e34c38837b5b5495ad6d295d0e73d2 (patch)
tree039e513e5cebe1ba60b747372b50d8049edf29ae /.github
Squashed 'themes/PaperMod/' content from commit 5a46517
git-subtree-dir: themes/PaperMod git-subtree-split: 5a4651783fa9159123d947bd3511b355146d4797
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug.yaml112
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/enhancement.yaml32
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md44
-rw-r--r--.github/workflows/gh-pages.yml77
5 files changed, 270 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml
new file mode 100644
index 0000000..d7d7656
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yaml
@@ -0,0 +1,112 @@
+name: Bug Report 🐞
+description: Create a report to help us improve
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report :)
+ - Kindly **DO NOT** ask for instructions.
+ - Use [Discussions](https://github.com/adityatelange/hugo-PaperMod/discussions) section if you have a query or doubts or any other relevant question.
+ - You may join [Discord community](https://discord.gg/ahpmTvhVmp) to interact with fellow contributors and users
+ - Read project's [Wiki](https://github.com/adityatelange/hugo-PaperMod/wiki) for detailed documentation.
+ - Read project's [FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs) section for Frequently asked questions.
+ - Search for previous [Issues](https://github.com/adityatelange/hugo-PaperMod/issues)/[Pull Requests](https://github.com/adityatelange/hugo-PaperMod/pulls) if this issue is already reported or fix has been created.
+ - type: textarea
+ id: what_happened
+ attributes:
+ label: What happened?
+ description: Also tell us, what did you expect to happen?
+ placeholder: A bug happened! Here are the screenshots.. Tell us what you see!
+ validations:
+ required: true
+ - type: textarea
+ id: steps_to_reproduce
+ attributes:
+ label: Steps to reproduce
+ description: How to reproduce this issue. Here are the steps...
+ placeholder: |
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. See error
+ validations:
+ required: true
+ - type: dropdown
+ id: hugo_version
+ attributes:
+ label: Hugo Version
+ description: What version of Hugo are you running?
+ options:
+ - Hugo >= 0.146.0 (Recommended - Minimum version required for PaperMod)
+ - Hugo < 0.146.0 (Incompatible - Not recommended to build PaperMod on lower versions)
+ validations:
+ required: true
+ - type: input
+ id: papermod_version
+ attributes:
+ label: PaperMod Version
+ description: What version of PaperMod are you running?
+ placeholder: |
+ PaperMod v7.0 or
+ Branch master or
+ Commit-id: 3f50861a0ced88f9b614a43662edeb4c0bc45da8
+ validations:
+ required: true
+ - type: dropdown
+ id: browser_type
+ attributes:
+ label: What kind of devices are you seeing the problem on?
+ multiple: true
+ options:
+ - Mobile
+ - Desktop
+ validations:
+ required: false
+ - type: dropdown
+ id: browsers
+ attributes:
+ label: What browsers are you seeing the problem on?
+ multiple: true
+ options:
+ - Firefox
+ - Chrome
+ - Safari
+ - Microsoft Edge
+ validations:
+ required: false
+ - type: input
+ id: browser_version
+ attributes:
+ label: Browser Version
+ description: Please add browser version or enter user agent string (navigator.userAgent)
+ placeholder: ex. Google Chrome 86.0
+ validations:
+ required: false
+ - type: textarea
+ id: logs
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: shell
+ validations:
+ required: true
+ - type: input
+ id: repo_url
+ attributes:
+ label: Repository/Source Code link where this issue can be reproduced
+ description: Please add url of the repository where this issue can be reproduced
+ placeholder: https://github.com/<username>/<repo name>
+ validations:
+ required: false
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: Code of Conduct
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/adityatelange/hugo-PaperMod?tab=coc-ov-file#readme).
+ options:
+ - label: I agree to follow this project's Code of Conduct
+ required: true
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..eeb6e55
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: PaperMod Discussions
+ url: https://github.com/adityatelange/hugo-PaperMod/discussions
+ about: Please ask and answer questions/doubts here, DO NOT open an issue for questions.
diff --git a/.github/ISSUE_TEMPLATE/enhancement.yaml b/.github/ISSUE_TEMPLATE/enhancement.yaml
new file mode 100644
index 0000000..3976a80
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement.yaml
@@ -0,0 +1,32 @@
+name: Enhancement 🚀
+description: Propose a new feature or change for enhancing the experience.
+title: "[Enhancement]: "
+labels: ["enhancement", "triage"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this enhancement form :)
+ - Use [Discussions](https://github.com/adityatelange/hugo-PaperMod/discussions) section if you have a query or doubts or any other relevant question.
+ - You may join [Discord community](https://discord.gg/ahpmTvhVmp) to interact with fellow contributors and users
+ - Read project's [Wiki](https://github.com/adityatelange/hugo-PaperMod/wiki) for detailed documentation.
+ - Read project's [FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs) section for Frequently asked questions.
+ - Search for previous [Issues](https://github.com/adityatelange/hugo-PaperMod/issues)/[Pull Requests](https://github.com/adityatelange/hugo-PaperMod/pulls) if this issue is already reported or fix has been created.
+ - type: textarea
+ id: what_happened
+ attributes:
+ label: What you'd like to propose?
+ description:
+ placeholder:
+ validations:
+ required: true
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: Code of Conduct
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/adityatelange/hugo-PaperMod?tab=coc-ov-file#readme).
+ options:
+ - label: I agree to follow this project's Code of Conduct
+ required: true
+ validations:
+ required: true \ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..673d1c4
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,44 @@
+<!--
+
+## READ BEFORE OPENING A PR
+
+Thank you for contributing to hugo-PaperMod!
+Please fill out the following questions to make it easier for us to review your
+changes. You do not need to check all the boxes below.
+
+**NOTE**: PaperMod does not have any external dependencies fetched from 3rd party
+CDN servers. However we do have custom Head/Footer extender templates which you can use
+to add those to your website.
+https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#custom-head--footer
+
+-->
+
+
+**What does this PR change? What problem does it solve?**
+
+<!--
+Describe the changes and their purpose here, as detailed as and if needed.
+
+Please do not add 2 unrelated changes in a single PR as it is difficult to track/revert those in future.
+-->
+
+
+**Was the change discussed in an issue or in the Discussions before?**
+
+<!--
+Link issues and relevant Discussions posts here.
+
+If this PR resolves an issue on GitHub, use "Closes #1234" so that the issue
+is closed automatically when this PR is merged.
+-->
+
+
+## PR Checklist
+
+- [ ] This change adds/updates translations and I have used the [template present here](https://github.com/adityatelange/hugo-PaperMod/wiki/Translations#want-to-add-your-language-).
+- [ ] I have enabled [maintainer edits for this PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
+- [ ] I have verified that the code works as described/as intended.
+- [ ] This change adds a Social Icon which has a permissive license to use it.
+- [ ] This change **does not** include any CDN resources/links.
+- [ ] This change **does not** include any unrelated scripts such as bash and python scripts.
+- [ ] This change updates the overridden internal templates from HUGO's repository.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
new file mode 100644
index 0000000..7dc6f1c
--- /dev/null
+++ b/.github/workflows/gh-pages.yml
@@ -0,0 +1,77 @@
+name: Deploy Hugo PaperMod Demo to Pages
+
+on:
+ push:
+ paths-ignore:
+ - "images/**"
+ - "LICENSE"
+ - "README.md"
+ branches:
+ - master
+ - exampleSite
+ workflow_dispatch:
+ # manual run
+ inputs:
+ hugoVersion:
+ description: "Hugo Version"
+ required: false
+ default: "0.146.0"
+
+# Allow one concurrent deployment
+concurrency:
+ group: "pages"
+ cancel-in-progress: true
+
+# Default to bash
+defaults:
+ run:
+ shell: bash
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+jobs:
+ # Build job
+ build:
+ runs-on: ubuntu-latest
+ env:
+ HUGO_VERSION: ${{ github.event.inputs.hugoVersion || '0.146.0' }}
+ steps:
+ - name: Install Hugo CLI
+ run: |
+ wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_linux-amd64.deb \
+ && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+ - name: Checkout
+ uses: actions/checkout@v4
+ with:
+ ref: exampleSite
+ - name: Setup Pages
+ id: pages
+ uses: actions/configure-pages@v5
+ - name: Get Theme
+ run: git submodule update --init --recursive
+ - name: Update theme to Latest commit
+ run: git submodule update --remote --merge
+ - name: Build with Hugo
+ run: |
+ hugo \
+ --buildDrafts --gc \
+ --baseURL ${{ steps.pages.outputs.base_url }}
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: ./public
+ # Deployment job
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ needs: build
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4