Skip to content

Shared bits around multiple repositories

License

Notifications You must be signed in to change notification settings

readthedocs/common

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5e22caf · Mar 18, 2025
Oct 14, 2024
Mar 18, 2025
Feb 5, 2025
Oct 29, 2024
Mar 11, 2025
Mar 15, 2018
Oct 30, 2018
Jan 7, 2019
Jan 21, 2020
Apr 6, 2018
Aug 17, 2022
Mar 11, 2025
Mar 21, 2019
Nov 9, 2021

Repository files navigation

Read the Docs common development files

Common shared bits for development and release tooling across multiple repositories.

Installing

To install:

git submodule add git@github.com:rtfd/common.git common
git submodule update
make -f common/common.mk

Setup

The release process automatically handles updating the changelog and incrementing a version in setup.cfg. You'll need a few extra piece to make this work in each repository: a version to manipulate and information on the repo for changelog automation.

There are several options that can come under the tool:release section:

github_owner
The GitHub repository owner name
github_repo
The GitHub repository name
github_private
Is the repository private? This also requires the use of a GITHUB_TOKEN environment variable when pulling changelog. You can generate this at: https://github.com/settings/tokens

Additionally, setup.cfg can track all of the setup.py options in plaintext. For an example of how to migrate all the setup.py options to setup.cfg, see readthedocs.org or readthedocs-corporate.

Here's an example configuration:

[metadata]
version = 1.0.0

[tool:release]
github_owner = rtfd
github_repo = readthedocs.org
github_private = False

About

Shared bits around multiple repositories

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published