https://github.com/percona-lab/pmm-submodules
A repo dedicated to building Percona Monitoring and Management (PMM)
https://github.com/percona-lab/pmm-submodules
pmm
Last synced: 11 months ago
JSON representation
A repo dedicated to building Percona Monitoring and Management (PMM)
- Host: GitHub
- URL: https://github.com/percona-lab/pmm-submodules
- Owner: Percona-Lab
- License: agpl-3.0
- Created: 2017-12-14T18:25:41.000Z (over 8 years ago)
- Default Branch: PMM-2.0
- Last Pushed: 2025-05-05T15:34:57.000Z (11 months ago)
- Last Synced: 2025-05-05T22:16:41.448Z (11 months ago)
- Topics: pmm
- Language: Python
- Homepage:
- Size: 4.76 MB
- Stars: 12
- Watchers: 25
- Forks: 29
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# PMM Submodules
This repository serves the purpose of creating and/or updating the feature builds for PMM Server and PMM Client. It is auxiliary
to our build system managed by Jenkins as it helps pull the right branches from different repositories that PMM [consists of](https://github.com/percona/pmm/blob/main/CONTRIBUTING.md#project-repos-structure).
# Installation of dependencies
If you build with Python's script then you need to install the dependencies:
```
pip install -r requirements.txt
```
## How to create a feature build
To create a feature build (FB) you have to edit `ci.yml` and specify the branches that you want the system to pull when building a feature. For example:
```yaml
deps:
- name: pmm
branch: PMM-0000-fix-everything
- name: pmm-qa
branch: PMM-0000-fix-everything-and-even-more
```
To build from a fork, you need to specify `url` for the dependency, for example:
```yaml
deps:
- name: pmm-server
url: https://github.com//pmm-server
branch: PMM-0000-fix-everything
```
Next, you will commit changes to git and push them to the repo:
```
git add ci.yml
git commit -m 'use custom branches'
git push
```
Whenever you commit and push to a feature branch, a Jenkins job will be triggered and it will start building your feature. You can follow its progress right from the PR's actions (at the bottom of each PR).
## Using a Personal Access Token (PAT)
Given that github is limiting the number of API requests for unauthenticated users, it'd be a good idea to use your personal access token. You can create a personal token in [Github settings](https://github.com/settings/tokens). Generate New Token -> Click on a repo -> Create an environment variable called `GITHUB_API_TOKEN` and provide your token as the value.
The token requires the following permissions:
- `repo:status`
- `public_repo`
- `read:user`
It is recommended to set an expiration date for your token.
if you use zsh:
```console
echo 'export GITHUB_API_TOKEN=********' >> ~/.zshrc
source ~/.zshrc
```
if you use bash:
```console
echo 'export GITHUB_API_TOKEN=********' >> ~/.bash_profile
source ~/.bash_profile
```
NOTE: Please make sure you don't commit your PAT to github. Should the PAT accidentally leak out, please revoke it asap and re-create it.
## FAQ
### What if my FB is made up of branches with the same name?
If you use the same branch name in all repos then you can run:
```console
make prepare
```
Branches with "you branch name" will be used for all repos or the default branch (usually called `main`) if the branch with this name isn't found in the repo.
If you want to create a FB from a fork, you can pass an environment variable "FORK_OWNER" which should be equal to your username in github and run:
```console
FORK_OWNER= make prepare
```
### I got an error "...branch has no upstream branch"
This happens because of your newly created branch. Your Git is not configured to create that same branch on remote. To fix this you can run:
```console
git config --global push.default current
```
### What's a `global` repo in ci.yml?
It's a branch name that this script will try to find in a repo instead of the default branch (usually called `main` or `PMM-2.0`).
### Can I build my FB as before using .gitmodules?
Certainly. If `ci.yml` is left empty, the system will pick the branches from `.gitmodules` as before. The mix of both however is not supported.