Vanity overhaul #3

jolheiser · 2020-09-12T03:33:00Z

jolheiser commented

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

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 added 5 commits 2020-09-12 03:33:02 +00:00

Initial Overhaul

Signed-off-by: jolheiser <john.olheiser@gmail.com>

0c0df403d1

Add GitLab support

Signed-off-by: jolheiser <john.olheiser@gmail.com>

6d7150e0a2

Better config options, change package structure

Signed-off-by: jolheiser <john.olheiser@gmail.com>

35b809dc85

README cleanup

Signed-off-by: jolheiser <john.olheiser@gmail.com>

ab84fdea97

More debug output and template fixes

Signed-off-by: jolheiser <john.olheiser@gmail.com>

c8b30a9731

jolheiser commented

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

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.

jolheiser referenced this issue from a commit

2020-09-12 15:23:27 +00:00

Vanity overhaul (#3)

jolheiser merged commit 693e58df7f into master

2020-09-12 15:23:28 +00:00

jolheiser deleted branch overhaul

2020-09-12 15:24:37 +00:00

jolheiser added the

enhancement

label 2020-09-29 21:41:28 +00:00

This repo is archived. You cannot comment on pull requests.

No reviewers