{"id":29099907,"url":"https://github.com/bcc-code/bcc-documentation-base","last_synced_at":"2026-02-14T13:34:10.317Z","repository":{"id":65380943,"uuid":"586908105","full_name":"bcc-code/bcc-documentation-base","owner":"bcc-code","description":"A base VuePress theme that can be used to render documentation for other BCC projects","archived":false,"fork":false,"pushed_at":"2025-09-24T06:13:19.000Z","size":907,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-11-21T05:15:23.488Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://developer.bcc.no/bcc-documentation-base","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bcc-code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-01-09T14:12:41.000Z","updated_at":"2025-09-24T06:12:48.000Z","dependencies_parsed_at":"2025-02-24T16:36:25.373Z","dependency_job_id":null,"html_url":"https://github.com/bcc-code/bcc-documentation-base","commit_stats":{"total_commits":119,"total_committers":6,"mean_commits":"19.833333333333332","dds":0.4873949579831933,"last_synced_commit":"860b39a1740cd58115445e5473ad1d13a6cd68da"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/bcc-code/bcc-documentation-base","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcc-code%2Fbcc-documentation-base","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcc-code%2Fbcc-documentation-base/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcc-code%2Fbcc-documentation-base/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcc-code%2Fbcc-documentation-base/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bcc-code","download_url":"https://codeload.github.com/bcc-code/bcc-documentation-base/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcc-code%2Fbcc-documentation-base/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29444751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T12:43:28.304Z","status":"ssl_error","status_checked_at":"2026-02-14T12:43:14.160Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-06-28T17:37:47.890Z","updated_at":"2026-02-14T13:34:10.285Z","avatar_url":"https://github.com/bcc-code.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BCC documentation base template\n\nThis repository holds the base for documentation of all BCC projects. It consists of these parts:\n- `vuepress` - This is a VuePress base template including a theme, to be used by different documentation sites. Read more in [its readme](./vuepress/README.md).\n- `docs` - Public documentation for this project.\n- `action.yml` - A GitHub Action to be used by other repositories to build the documentation.\n- `auth-proxy` - A proxy that is used in Azure to require GitHub login for all documentation sites.\n\n## Updating the GitHub Action\nThe `action.yml` file is a [composite](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) GitHub Action. It is used by workflows in other repositories like this:\n\n```yml\nsteps:\n    - name: Build documentation site\n        uses: bcc-code/bcc-documentation-base@v1\n        with:\n            title: Documentation Guide\n            description: Information on how to set up documentation for BCC projects\n```\n\nYou can see a full workflow in action [in this repository](./.github/workflows/build-and-deploy-documentation.yml), as it is used here as well to build the documentation.\n\nThe \"version\" of the Action (the `@v1` part) is just a tag that is added to a commit on this repository. When updating the `action.yml` file, there are two ways to propagate this update to all the other repositories.\n\n### 1. Create a new tag\nThis is the easiest approach. Use this if there are any breaking changes to the action, such as renaming an argument. Create a new tag with a comment like this:\n```sh\ngit tag -a -m \"Action: Add argument\" v2\n```\nThis creates a `v2` tag with a comment of `Action: Add argument`.\n\nThen push the tag to GitHub (and any non-pushed commits) by appending the `follow-tags` flag to `git push`:\n```sh\ngit push --follow-tags\n```\n\nAfter doing this, all the workflows in this and other repositories need to be updated to use that `v2` tag. This enables gradual adoption, but the downside is of course a potential burden of having to upgrade a lot of repositories.\n\n### 2. Republish an existing tag\nBy deleting and republishing the last tag, any future workflow will use the updated version without having to update all the other workflows. This is a **dangerous** action though, as an error in the configuration can lead to all repositories breaking, and you're deleting the tag from the server forever. **Only use this for backwards compatible changes**.\n\nFirst delete the tag locally:\n```sh\ngit tag -d v1\n```\n\nThen delete it on GitHub:\n```sh\ngit push --delete origin v1\n```\n\nThe run the two commands under option 1 to create and push this tag. Note that any workflows running between deleting the old tag and pushing the new tag will fail.\n\n## License\nEverything in this repository is licensed under the [Apache 2.0 license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcc-code%2Fbcc-documentation-base","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbcc-code%2Fbcc-documentation-base","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcc-code%2Fbcc-documentation-base/lists"}