{"id":13929462,"url":"https://github.com/jsnjack/hugo-changelog-theme","last_synced_at":"2025-04-05T21:08:06.775Z","repository":{"id":75802445,"uuid":"147115762","full_name":"jsnjack/hugo-changelog-theme","owner":"jsnjack","description":"A Hugo changelog theme","archived":false,"fork":false,"pushed_at":"2025-01-21T15:02:20.000Z","size":282,"stargazers_count":109,"open_issues_count":3,"forks_count":30,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T20:06:06.661Z","etag":null,"topics":["changelog","hugo","theme"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsnjack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-02T19:35:09.000Z","updated_at":"2025-02-04T13:27:36.000Z","dependencies_parsed_at":"2024-11-26T18:42:50.003Z","dependency_job_id":null,"html_url":"https://github.com/jsnjack/hugo-changelog-theme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fhugo-changelog-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fhugo-changelog-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fhugo-changelog-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsnjack%2Fhugo-changelog-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsnjack","download_url":"https://codeload.github.com/jsnjack/hugo-changelog-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399877,"owners_count":20932876,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog","hugo","theme"],"created_at":"2024-08-07T18:02:21.690Z","updated_at":"2025-04-05T21:08:06.753Z","avatar_url":"https://github.com/jsnjack.png","language":"HTML","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"Hugo Changelog Theme\n=====\n\nA [Hugo](https://gohugo.io/) theme to display a changelog\n\n# Features\n - Build with [Spectre.css](https://picturepan2.github.io/spectre/) (All unused components are disabled)\n - Pagination\n - Mobile friendly\n\n# How to install\n - Clone the repository with `--recursive` flag as the theme includes submodule\n   ```bash\n   git clone git@github.com:jsnjack/hugo-changelog-theme.git --recursive\n   ```\n - Use hugo extended version\n\n# Workflow\n\n## Conventions\n - Create non-released entries in `experimental/` folder. All of them are displayed in the top of the first page\n - Create deprecation entries in `deprecated/` folder. Deprecated entries appear in a dropdown section on top of the first page\n - Create released entries in `released/` folders. Entries are sorted by Weight. Weight is displayed as version\n - Your hugo changelog website is located in `site/changelog/` folder\n - You are using `master` branch as the stable branch and `develop` branch as a working branch (needed for the post-merge webhook only)\n\n## Scripts\n - `Makefile` - list of useful commands\n - `release.py` - moves changes from the `experimental/` folder to the `released/` folder, assigns version number and generates release-commit\n - `.githooks/post-merge` - verifies that `experimental/` folder is empty during the merge from the working branch to the stable branch\n\n## Dependencies\n - For release script:\n   ```bash\n    sudo pip install python-frontmatter\n   ```\n\n## Description\n1. When a pull request is ready, a developer creates a changelog entry:\n   ```bash\n   make change\n   ```\n   The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/experimental/` folder\n\n2. If necessary, the developer creates a deprecation entry:\n   ```bash\n   make deprecation\n   ```\n   The command creates a *.md file with random name (ensures that there will be no merge conflicts) in `site/changelog/content/deprecated/` folder.\n   Note that deprecation entries are not removed automatically. When a certain deprecated feature reaches the end of life period, the corresponding\n   file in the `deprecation/` folder has to be removed manually\n\n3. The developer updates created files with changes. Changes are going to be rendered in the `experimental` section of the template\n\n4. Preview the site with the command:\n   ```bash\n   make serve_changelog\n   ```\n\n5. When the working branch is ready to be merged in the stable branch, the developer runs:\n   ```bash\n   make release\n   ```\n   The command will move all *.md files from the `experimental/` folder to the `released/` folder, assign the release version and generate the commit with related changes\n\n6. The developer merges working branch in to the stable branch\n\n\n# Shortcodes\n - `{{\u003c tag fixed \u003e}}` - create a specific tag before entry text. Available tag types are: added, changed, fixed, deprecated, removed, performance, security, self-hosted\n\n# Settings\n```\n[params]\n    customCSS = [\"css/styles.css\"]  # List of css files to include on the website. Relative to the static/ folder\n    customJS = [\"js/script.js\"]     # List of js files to include on the website. Relative to the static/ folder\n```\n\n# Development\n## Serve example website\n```bash\ncd exampleSite \u0026\u0026 hugo serve --theme hugo-changelog-theme --themesDir ../../ --baseURL http://localhost/\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsnjack%2Fhugo-changelog-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsnjack%2Fhugo-changelog-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsnjack%2Fhugo-changelog-theme/lists"}