Vanity overhaul #3

2020-09-12T03:33:00Z

jolheiser commented

2020-09-12 03:33:00 +00:00

(Migrated from gitea.com)

Resolves #2

This is a breaking change from v0.1.x

However, this version may bring us to a real v1.0.0 once any potential bugs are fixed, as it should be far easier to keep up-to-date.

This is almost a complete re-work that will use APIs to automatically scan a user (or org) namespace, pick out the Go projects, and reflect a vanity URL if applicable.

In order for a project to be reflected, it must fulfill the following requirements.

It must be public (unless the corresponding configuration is set to allow private, forked, mirrored, or archived projects)
It must have a go.mod file in the root directory (unless manually added to and subsequently loaded from a config file)
The go.mod file must declare the module as using the same domain vanity runs with
It must not be excluded by any exclusion rules (regex)
1. If any inclusion rules (regex) are given, only projects that match will be reflected

It might seem like a lot of hoops, but vanity is designed so that by default only applicable projects are reflected. Any guesswork is left out and must have manual intervention.

Resolves #2 This is a breaking change from `v0.1.x` However, this version may bring us to a real `v1.0.0` once any potential bugs are fixed, as it should be far easier to keep up-to-date. This is almost a complete re-work that will use APIs to automatically scan a user (or org) namespace, pick out the Go projects, and reflect a vanity URL if applicable. In order for a project to be reflected, it must fulfill the following requirements. 1. It must be public (unless the corresponding configuration is set to allow private, forked, mirrored, or archived projects) 2. It must have a `go.mod` file in the root directory (unless manually added to and subsequently loaded from a config file) 3. The `go.mod` file must declare the module as using the same domain vanity runs with 4. It must not be excluded by any exclusion rules (regex) 1. If any inclusion rules (regex) are given, **only** projects that match will be reflected It might seem like a lot of hoops, but vanity is designed so that by default only applicable projects are reflected. Any guesswork is left out and must have manual intervention.

jolheiser commented

2020-09-12 15:20:59 +00:00

(Migrated from gitea.com)

It should be noted that users who don't want to reach outside their network can set service to off and instead add packages manually to their config.

It should be noted that users who don't want to reach outside their network can set `service` to `off` and instead add packages manually to their config.

Sign in to join this conversation.

No reviewers