Add gitea / forgejo support

.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120,
+  "tabWidth": 2,
+  "endOfLine": "lf"
+}

Dockerfile

@@ -4,15 +4,16 @@ WORKDIR /app
 
 ENV NODE_ENV=production
 
-COPY ["package.json", "pnpm-lock.yaml", "./"]
-COPY ["tsconfig.json", "./"]
-COPY ["src", "./src"]
-
 RUN apt update \
 	&& apt install -y git git-lfs wget \
 	&& apt-get clean \
 	&& rm -rf /var/lib/apt/lists/*
 RUN corepack enable
+
+COPY ["package.json", "pnpm-lock.yaml", "./"]
 RUN pnpm install --frozen-lockfile
 
+COPY ["tsconfig.json", "./"]
+COPY ["src", "./src"]
+
 CMD ["/app/node_modules/.bin/tsx", "/app/src/run.ts"]

README.md

@@ -66,8 +66,10 @@ export default {
 - [x] Support first release (no previous tags)
 - [x] Support defining next version manually (can be done by changing the version on the release pull-request title / commit message)
 - [ ] Support more forges:
-  - [ ] Gitea
+  - [x] Github
+  - [x] Gitea
   - [ ] Gitlab
+  - [ ] Bitbucket
 
 ## Credits
 

docs.md

@@ -44,13 +44,15 @@ There are two parts to configure the plugin:
 
 ### 1. Most basic options can be configured via plugin settings
 
-| Settings                     | Default                | Description                                       |
-| ---------------------------- | ---------------------- | ------------------------------------------------- |
-| `GITHUB_TOKEN`               | _none_                 | The GitHub token to use for the GitHub API        |
-| `GIT_EMAIL`                  | _none_                 | The email to use for git commits                  |
-| `RELEASE_BRANCH`             | CI_REPO_DEFAULT_BRANCH | The branch used to merge the changelog to         |
-| `PULL_REQUEST_BRANCH_PREFIX` | `next-release/`        | The prefix used for release pull-request branches |
-| `DEBUG`                      | `false`                | Enable debug logging                              |
+| Settings                      | Default                | Description                                               |
+| ----------------------------- | ---------------------- | --------------------------------------------------------- |
+| `FORGE_TYPE`                  | CI_FORGE_TYPE          | The forge type we connect to (github, gitea, ...)         |
+| `FORGE_URL`                   | CI_FORGE_URL           | The url to the forge used for the API client              |
+| `FORGE_TOKEN`, `GITHUB_TOKEN` | _none_                 | The auth token to use for the forge API (e.g. github API) |
+| `GIT_EMAIL`                   | _none_                 | The email to use for git commits                          |
+| `RELEASE_BRANCH`              | CI_REPO_DEFAULT_BRANCH | The branch used to merge the changelog to                 |
+| `PULL_REQUEST_BRANCH_PREFIX`  | `next-release/`        | The prefix used for release pull-request branches         |
+| `DEBUG`                       | `false`                | Enable debug logging                                      |
 
 ### 2. Using a `release-config.ts` file in your repository
 

package.json

@@ -16,6 +16,7 @@
   "dependencies": {
     "@octokit/rest": "^21.0.0",
     "execa": "^9.0.0",
+    "gitea-js": "^1.22.0",
     "picocolors": "^1.0.0",
     "semver": "^7.5.3",
     "shelljs": "^0.8.5",

src/forges/gitea.ts

@@ -0,0 +1,180 @@
+import { Forge, PullRequest } from './forge';
+import { giteaApi, Api } from 'gitea-js';
+
+export class GiteaForge extends Forge {
+  accessToken: string;
+  email: string;
+  api: Api<unknown>;
+  url: string;
+
+  constructor(url: string, accessToken: string, email: string) {
+    super();
+    this.email = email;
+    this.accessToken = accessToken;
+    this.url = url;
+    this.api = giteaApi(url, {
+      token: accessToken, // generate one at https://gitea.example.com/user/settings/applications
+    });
+  }
+
+  async handleApiErrors<T>(promise: Promise<T>, ignoreErrors = [404]): Promise<T | undefined> {
+    return promise.catch((error) => {
+      const status = (error as Response)?.status;
+      if (ignoreErrors.includes(status)) {
+        console.error('gitea error', error);
+      }
+
+      return undefined;
+    });
+  }
+
+  async createOrUpdatePullRequest(options: {
+    draft: boolean;
+    title: string;
+    description: string;
+    owner: string;
+    repo: string;
+    sourceBranch: string;
+    targetBranch: string;
+  }): Promise<{ pullRequestLink: string }> {
+    const pullRequest = await this.handleApiErrors(
+      this.api.repos.repoGetPullRequestByBaseHead(
+        options.owner,
+        options.repo,
+        options.targetBranch,
+        options.sourceBranch,
+      ),
+    );
+
+    if (pullRequest?.data) {
+      const pr = await this.api.repos.repoEditPullRequest(options.owner, options.repo, pullRequest.data.number!, {
+        title: options.title,
+        body: options.description,
+      });
+
+      return { pullRequestLink: pr.data.html_url! };
+    }
+
+    const pr = await this.api.repos.repoCreatePullRequest(options.owner, options.repo, {
+      title: options.title,
+      head: options.sourceBranch,
+      base: options.targetBranch,
+      body: options.description,
+    });
+
+    return { pullRequestLink: pr.data.html_url! };
+  }
+
+  async createRelease(options: {
+    owner: string;
+    repo: string;
+    tag: string;
+    name: string;
+    description: string;
+    prerelease?: boolean;
+  }): Promise<{ releaseLink: string }> {
+    const release = await this.api.repos.repoCreateRelease(options.owner, options.repo, {
+      tag_name: options.tag,
+      name: options.name,
+      body: options.description,
+      prerelease: options.prerelease,
+    });
+
+    return { releaseLink: release.data.html_url! };
+  }
+
+  async getGitCredentials(): Promise<{
+    email: string;
+    username: string;
+    password: string;
+  }> {
+    return {
+      email: this.email,
+      username: 'oauth',
+      password: this.accessToken,
+    };
+  }
+
+  async getPullRequest(options: {
+    owner: string;
+    repo: string;
+    sourceBranch: string;
+    targetBranch: string;
+  }): Promise<PullRequest | undefined> {
+    const pullRequest = await this.handleApiErrors(
+      this.api.repos.repoGetPullRequestByBaseHead(
+        options.owner,
+        options.repo,
+        options.targetBranch,
+        options.sourceBranch,
+      ),
+    );
+
+    if (!pullRequest?.data) {
+      return undefined;
+    }
+
+    return {
+      // TODO: check if those fields are always present and we can safely use ! here
+      title: pullRequest.data.title!,
+      author: pullRequest.data.user?.login!,
+      number: pullRequest.data.number!,
+      labels: pullRequest.data.labels?.map((label) => label.name!) ?? [],
+      description: pullRequest.data.body!,
+    };
+  }
+
+  async getPullRequestFromCommit(options: {
+    owner: string;
+    repo: string;
+    commitHash: string;
+  }): Promise<PullRequest | undefined> {
+    const pullRequest = await this.handleApiErrors(
+      this.api.repos.repoGetCommitPullRequest(options.owner, options.repo, options.commitHash),
+    );
+
+    if (!pullRequest?.data) {
+      return undefined;
+    }
+
+    return {
+      // TODO: check if those fields are always present and we can safely use ! here
+      title: pullRequest.data.title!,
+      author: pullRequest.data.user?.login!,
+      number: pullRequest.data.number!,
+      labels: pullRequest.data.labels?.map((label) => label.name!) ?? [],
+      description: pullRequest.data.body!,
+    };
+  }
+
+  async addCommentToPullRequest(options: {
+    owner: string;
+    repo: string;
+    pullRequestNumber: number;
+    comment: string;
+  }): Promise<void> {
+    await this.api.repos.issueCreateComment(options.owner, options.repo, options.pullRequestNumber, {
+      body: options.comment,
+    });
+  }
+
+  getRepoUrl(owner: string, repo: string): string {
+    return `${this.url}/${owner}/${repo}`;
+  }
+
+  getCommitUrl(owner: string, repo: string, commitHash: string): string {
+    return `${this.url}/${owner}/${repo}/src/commit/${commitHash}`;
+  }
+
+  getIssueUrl(owner: string, repo: string, issueNumber: string | number): string {
+    return `${this.url}/${owner}/${repo}/issues/${issueNumber}`;
+  }
+
+  getPullRequestUrl(owner: string, repo: string, pullRequestNumber: string | number): string {
+    return `${this.url}/${owner}/${repo}/pulls/${pullRequestNumber}`;
+  }
+
+  getReleaseUrl(owner: string, repo: string, release: string): string {
+    return `${this.url}/${owner}/${repo}/releases/tag/${release}`;
+  }
+}

src/forges/index.ts

@@ -1,18 +1,31 @@
 import { Config } from '../utils/config';
 import { Forge } from './forge';
 import { GithubForge } from './github';
+import { GiteaForge } from './gitea';
 
 export async function getForge(config: Config): Promise<Forge> {
+  if (!config.ci.gitEmail) {
+    throw new Error('Please provide a `git_email`');
+  }
+
   if (config.ci.forgeType === 'github') {
-    if (!config.ci.githubToken) {
-      throw new Error('Please provide a Github token');
+    if (!config.ci.forgeToken) {
+      throw new Error('Please provide a `forge_token`');
+    }
+
+    return new GithubForge(config.ci.forgeToken, config.ci.gitEmail);
+  }
+
+  if (config.ci.forgeType === 'gitea' || config.ci.forgeType === 'forgejo') {
+    if (!config.ci.forgeToken) {
+      throw new Error('Please provide a `forge_token`');
     }
 
-    if (!config.ci.gitEmail) {
-      throw new Error('Please provide a Git email');
+    if (!config.ci.forgeURL) {
+      throw new Error('Please provide the `forge_url` to your Gitea instance');
     }
 
-    return new GithubForge(config.ci.githubToken, config.ci.gitEmail);
+    return new GiteaForge(config.ci.forgeURL, config.ci.forgeToken, config.ci.gitEmail);
   }
 
   throw new Error('Forge type not supported: ' + config.ci.forgeType);

src/index.test.ts

@@ -17,7 +17,8 @@ const config: Config = {
     repoOwner: 'woodpecker-ci',
     repoName: 'woodpecker',
     forgeType: 'github',
-    githubToken: '123',
+    forgeToken: '123',
+    forgeURL: '',
     pullRequestBranchPrefix: 'next-release/',
     isCI: true,
     releasePrefix: '🎉 Release',

src/index.ts

@@ -47,6 +47,7 @@ export async function run({ git, forge, config }: { git: SimpleGit; forge: Forge
     const remote = remotes[0].refs.push.replace('://', `://${credentials.username}:${credentials.password}@`);
     await git.removeRemote(remotes[0].name);
     await git.addRemote(remotes[0].name, remote);
+    console.log('# Remote updated with credentials.');
   }
 
   const { releaseBranch } = config.ci;
@@ -55,6 +56,7 @@ export async function run({ git, forge, config }: { git: SimpleGit; forge: Forge
   await git.checkout(releaseBranch);
   await git.branch(['--set-upstream-to', `origin/${releaseBranch}`]);
   await git.pull();
+  console.log('# Checked out release branch:', c.green(releaseBranch));
 
   const isReleaseCommit = config.ci.commitMessage?.startsWith(config.ci.releasePrefix);
 
@@ -77,6 +79,8 @@ export async function run({ git, forge, config }: { git: SimpleGit; forge: Forge
     shouldBeRC = getReleaseOptions(releasePullRequest).nextVersionShouldBeRC;
   }
 
+  console.log('# Should next version be a release candidate:', c.green(shouldBeRC ? 'yes' : 'no'));
+
   const tags = await git.tags(['--sort=-creatordate']);
   let latestTag = tags.latest;
 

src/utils/change.test.ts

@@ -70,7 +70,8 @@ const config: Config = {
     repoOwner: 'woodpecker-ci',
     repoName: 'woodpecker',
     forgeType: 'github',
-    githubToken: '123',
+    forgeToken: '123',
+    forgeURL: '',
     pullRequestBranchPrefix: 'next-release/',
     isCI: true,
     releasePrefix: '🎉 Release',

src/utils/config.ts

@@ -8,8 +8,9 @@ const ciConfig = {
   eventType: process.env.CI_PIPELINE_EVENT,
   releaseBranch: process.env.PLUGIN_RELEASE_BRANCH || process.env.CI_REPO_DEFAULT_BRANCH || 'main',
   commitMessage: process.env.CI_COMMIT_MESSAGE,
-  forgeType: process.env.CI_FORGE_TYPE,
-  githubToken: process.env.PLUGIN_GITHUB_TOKEN,
+  forgeType: process.env.PLUGIN_FORGE_TYPE || process.env.CI_FORGE_TYPE,
+  forgeToken: process.env.PLUGIN_FORGE_TOKEN || process.env.PLUGIN_GITHUB_TOKEN,
+  forgeURL: process.env.PLUGIN_FORGE_URL || process.env.CI_FORGE_URL,
   gitEmail: process.env.PLUGIN_GIT_EMAIL,
   repoOwner: process.env.CI_REPO_OWNER,
   repoName: process.env.CI_REPO_NAME,
@@ -60,6 +61,7 @@ export const defaultUserConfig: UserConfig = {
       labels: ['misc', 'chore 🧰'],
       bump: 'patch',
       default: true,
+      weight: -1,
     },
   ],
   skipLabels: ['skip-release', 'skip-changelog', 'regression'],