Commit Graph
212 Commits
Author SHA1 Message Date
8abb365bbf migrate examples to openApi part 20: TUTORIAL.md (#9713)
* migrate examples to openApi part 20: TUTORIAL.md

* various tweaks

* Update doc/TUTORIAL.md

Co-authored-by: Pierre-Yves Bigourdan <10694593+PyvesB@users.noreply.github.com>

---------

Co-authored-by: Pierre-Yves Bigourdan <10694593+PyvesB@users.noreply.github.com>
2023-12-23 00:27:21 +00:00
chris48sandGitHub 595a9a90b7 link to mterczynski.pl/joi-schema-generator in validation docs (#9700) 2023-12-23 00:20:10 +00:00
CanisHelixandGitHub 8f1f787ceb [GITEA] add new gitea service (release/languages) (#9781)
* add gitea service based on gitlab

* update gitea to use mocks

* add gitea release test

* move tests to use public repo on codeberg and fixes

* add pagination, update tests to live, set gitea_url as required

* add auth test (wip)

* fix base auth test

* fix required optionalUrl, remove default, assume semver from firstpage

* update example to use stable repository
2023-12-18 12:39:17 +00:00
chris48sandGitHub 78f83249fa fix typo in docs (#9804) 2023-12-11 19:05:11 +00:00
chris48sandGitHub 19b50a66a6 call [pepy] with auth (#9748) 2023-11-19 19:24:56 +00:00
Prashant RawatandGitHub 48458206f9 fix mismatch in documentation and examples given in tutorial (#9580) 2023-09-17 07:04:56 +00:00
jNulljandGitHub 94a148b399 Docs: update TUTORIAL.md add BaseTomlService (#9518)
In the docs at TUTORIAL.md the new base service BaseTomlService was missing in the list of base services.
2023-08-27 11:15:10 +00:00
Prashant RawatandGitHub 865e8a0a01 use defaultBadgeData as object instead of function in tutorial docs (#9502) 2023-08-23 18:52:21 +00:00
chris48sGitHubxxchanrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
8f76982e1c Switch [OpenCollective] badges to use GraphQL and auth (#9387)
* [OpenCollective] update opencollective to api v2 (#9346)

* update opencollective to api v2

* fix tests

* fix: do not filter by accountType for opencollective/all

* remove 404

* remove required in schema

* cnt -> count

* keep by-tier code as-is

---------

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>

* allow calling OpenCollective api with an auth token

* add test for opencollective auth

* cache OpenCollective badges for longer

---------

Co-authored-by: xxchan <xxchan22f@gmail.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2023-08-20 18:24:38 +00:00
96e9e130de Add [CurseForge] badges (#9252)
* add curseforge downloads badge

* Add more [CurseForge] badges

Adds the following badges:
 - /curseforge/dt/:projectId (downloads)
 - /curseforge/game-versions/:projectId (game versions)
 - /curseforge/v/:projectId (version)

The following secret:
 - CURSEFORGE_API_KEY (yml: private.curseforge_api_key)

* Remove default logo from badges

* Linter fixes

* Rename `errorMessages` to `httpErrors`

* Remove namedLogo from ModrinthGameVersions badge

* Remove namedLogo from ModrinthVersion badge

* Remove namedLogo from ModrinthFollowers badge

---------

Co-authored-by: Minecraftschurli <minecraftschurli@gmail.com>
Co-authored-by: Pierre-Yves Bigourdan <10694593+PyvesB@users.noreply.github.com>
2023-08-13 18:00:40 +00:00
chris48sandGitHub 0ffa3669b3 deploy on node 18 (#9385)
* deploy on node 18, run tests on node 20

* run test-bug-run-badge on node 18

* you missed a spot

* ..and another
2023-08-10 18:40:17 +00:00
chris48sandGitHub d882433fd9 move some docs to the website (#9347)
* move some docs to the website

* update expected test value

* link to new documentation locations
2023-07-24 12:20:43 +01:00
chris48sandGitHub f84ccb24ae upgrade to npm 9 (#9323) 2023-07-16 15:07:20 +01:00
dependabot[bot]GitHubdependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>chris48s
b9d96755ec chore(deps-dev): bump prettier from 2.8.8 to 3.0.0 (#9357)
* chore(deps-dev): bump prettier from 2.8.8 to 3.0.0

Bumps [prettier](https://github.com/prettier/prettier) from 2.8.8 to 3.0.0.
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/2.8.8...3.0.0)

---
updated-dependencies:
- dependency-name: prettier
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* reformat all the things (prettier 3)

* update tests to await calls to prettier.format()

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: chris48s <git@chris-shaw.dev>
2023-07-10 09:27:51 +00:00
chris48sandGitHub 50ea7068a8 migrate frontend to docusaurus (#9014)
* delete loads of really important stuff that we definitely need

* v basic MVP smoosh docusaurus PoC into repo

* TODO

* delete more really important stuff

* TODO

* tidyup: use run-s

* don't redirect images used in frontend to raster proxy

* fix routing

* preserve the /endpoint link

* delete the blog (for now)

I would quite like to re-add this at some point
but its not really the top priority thing right now

* content edits

* appease the lint gods

* update danger rules

* remove placeholder

* cypress tests

* dockerhub --> ghcr

* Revert "dockerhub --> ghcr"

This reverts commit ef74cbb26b.

* downgrade lockfile format

* implement defs/BASE_URL

* fix e2e build

* actually fix cypress tests

* always run cypress tests on build

* this never worked

* add command for docusaurus:clear

* delete more code we don't need any more

* update ESLint/prettier config

* delete unsused exports

* documentation updates

* delete a fairly large chunk of our dependency tree

* allow base_url as build arg to Dockerfile

* fixup dockerfile

* work out base url at runtime if not set

doing this at image build time is not the right approach

* remove gatsby monorepo from closebot

* rename HomepageFeatures to homepage-features
2023-06-17 10:59:07 +01:00
chris48sandGitHub 14892e3943 Implement a pattern for dealing with upstream APIs which are slow on the first hit; affects [endpoint] (#9233)
* allow serviceData to override cacheSeconds with a longer value

* prevent [endpoint] json cacheSeconds property exceeding service default

* allow ShieldsRuntimeError to specify a cacheSeconds property

By default error responses use the cacheLength of
the service class throwing the error.

This allows error to tell the handling layer the maxAge
that should be set on the error badge response.

* add customExceptions param

This

1. allows us to specify custom properties to pass to the exception
   constructor if we throw any of the standard got errors
   e.g: `ETIMEDOUT`, `ECONNRESET`, etc
2. uses a custom `cacheSeconds` property (if set on the exception)
   to set the response maxAge

* customExceptions --> systemErrors

* errorMessages --> httpErrors
2023-06-13 21:08:43 +01:00
Pierre-Yves BigourdanGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2651e5fe87 Delete old deprecated services (#9254)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2023-06-12 07:49:20 +00:00
Laurent DemaillyandGitHub c773563e60 Correct issue template in footer (new badge requests url is incorrect) (#9153)
* Correct issue template in footer

https://github.com/badges/shields/issues/9152#issuecomment-1537534258

* Same in TUTORIAL.md
2023-05-07 16:18:33 -05:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
82dddab90f update docker hosting docs (#9018)
* update docs: DockerHub --> GHCR

* hey bro, you've got options

---------

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2023-03-28 19:21:47 +01:00
chris48sGitHubCaleb Cartwrightrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
ab51c88d94 update docs following token pool changes (#8933)
* update docs following token pool changes

* Update CONTRIBUTING.md

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>

---------

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2023-03-04 19:44:08 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
026e675dcf add a note about fine-grained PATs in the docs (#8823)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2023-01-23 19:46:19 +00:00
chris48sandGitHub affae9c521 docs/issue template improvements for badge requests (#8668)
* docs/issue template improvements for badge requests

* split markdown over multiple line, switch to folded multi-line string

* quotes round 'for the badge'

* fix typo

* improve docs on auth strategies

* document logoColor param in logos.md
2022-12-07 19:43:12 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
53c5cfa94d allow passing key to [stackexchange] (#8539)
* refactoring groundwork

* add stackapps_api_key setting

* add test for stackexchange auth

* clarify docs

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-12-04 10:53:59 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
5305e11f79 Remove 'suggest badges' feature (#8311)
* remove 'suggest badges' feature

* remove allowedOrigin/ALLOWED_ORIGIN setting

* keep allowedOrigin for now

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-11-09 18:15:59 +00:00
Paula BarszczGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
37a36f5fea Fix wording in code-walkthrough.md (#8240)
Fix wording and number of parameters in code-walkthrough.md

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-07-23 14:49:53 +00:00
Paula BarszczGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
3f63990049 Fix typo in service-tests.md (#8239)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-07-23 14:40:47 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
8f03cf6025 add docs on nouns in route (#8141)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-07-04 22:10:37 +00:00
Takuya NGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
040b52c1bd docs: update SVGO usage instruction (#8001)
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-05-29 17:29:17 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
07bc0325ee simplify NPM strict checks (#7973)
* simplify engine-strict/strict-peer-deps checks

* disable engine-strict for node 12/14 package tests

* update docs

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2022-05-17 20:23:06 +00:00
chris48sandGitHub 22afe7b648 update docs on production hosting (#7976) 2022-05-16 22:20:48 +00:00
Pierre-Yves BigourdanandGitHub 4163856357 Delete deprecated Codetally and continuousphp services (#7572) 2022-02-05 16:43:13 +01:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
344954f028 update raster proxy docs (#7348)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-12-05 15:31:49 +00:00
chris48sandGitHub feb1682814 Clean up cache module; affects [feedz jenkinsplugin myget node nuget packagist travis wordpress] (#7319)
* update terminology
    - "regular update" to "cached resource"
    - "interval" to "ttl"
    - move file and update imports

* set a default TTL, don't explicitly pass params if we want the default

* add tests

* update docs
2021-11-29 21:21:03 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
c73072deed Remove requestOptions2GotOptions compatibility layer (#7270)
* gzip --> decompress

* strictSSL --> https.rejectUnauthorized

* auth --> username/password

* qs --> searchParams

* fix base service auth docs

* completely remove requestOptions2GotOptions layer

* update the docs

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-11-15 19:56:08 +00:00
chris48sandGitHub 313dc983f1 upgrade to node 16 (#7271) 2021-11-15 19:29:50 +00:00
chris48sGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
f1b643df0d remove request from legacy request handler (#7233)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-11-06 10:59:58 +00:00
Caleb CartwrightGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
ae58e4a211 Add authentication for Libraries.io-based badges, run [Libraries Bower] (#7080)
* feat: support authentication on Libraries.io requests

* feat: wire up libraries.io config and api provider instantiation

* feat: create libraries.io and bower base classes

* refactor: tweak libraries/bower service classes and tests

* rename request fetcher function/arg

* throw exception when no tokens available

* cleanup old value

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-10-28 19:21:24 -05:00
cnicoGitHubCaleb Cartwrightrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
bab818b1c6 Doc self hosting correction (#7024)
* Correction of documentation for configuration

* Better content

* prettier correction

* Review asked to ignore local config file

* Apply suggestions from code review

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-10-17 21:03:07 +00:00
Dmitriy FishmanandGitHub 4c8a211feb Typo fix in releases.md (#7137) 2021-10-11 12:54:01 -04:00
Dominik GrzelakandGitHub 887ec5b441 Fix hyphens in docs for running code coverage (#7136) 2021-10-10 18:05:22 +00:00
Paul MelnikowandGitHub 4a8c1d1d0f Update Shields production access doc (#7079) 2021-09-28 16:28:03 -04:00
Caleb CartwrightGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
28cf98fff4 add documentation guide for adding new secrets (#7072)
* docs: add guide for adding new secrets

* generalize docs for adding secrets/settinsg

Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-09-27 22:34:37 +00:00
Florian "sp1ritGitHubCaleb Cartwrightrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
8a9efb2fc9 [OBS] add Open Build Service service-badge (#6993)
* service: add obs service

* service: obs: replaced replaceAll with replace and global regex

* service: obs: added space between class members

* service: obs: support for multiple instances

* service: obs: removed user prefix from auth vars

obs_userName is now called obs_user and obs_userPass is called obs_pass

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>

* service: obs: removed constructor hack in favour of serviceKey

* service: obs: apply suggestions from @calebcartwright

* service: obs: remove unneccesary http status mappings

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-09-25 17:44:56 +00:00
Caleb CartwrightGitHubIdeotecrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
961e13b229 Add API-based support for [GitLab] badges, add new GitLab Tag badge (#6988)
* Added GitLab Tag service

* Added prettyMessage for when repo has no tags

* Added pretty message for repo not found

* core: esm-ify gitlab tag service

* feat: support gitlab auth

* feat: support custom gitlab url on tag badges

* tests: add auth test for gitlab

* docs: fix gitlab config key references

* feat: support gitlab tag sorting options

* docs: add custom gitlab instance example for tags badge

* use v in gitlab route

* fix: gitlab tag examples

Co-authored-by: Ideotec <guille@ideotec.es>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-09-14 23:06:57 +00:00
Pierre-Yves BandGitHub 8fd54b1b8d Switch all shields.io links to https (#6935) 2021-08-22 17:20:59 +01:00
Pierre-Yves BandGitHub 71bbcd527b Fix badge classes links in tutorial (#6911) 2021-08-19 18:04:00 +01:00
chris48sandGitHub f4781804f6 Update self hosting docs (#6877)
* update node version

* remove notes on redis
2021-08-08 21:11:09 +01:00
Seth FalcoGitHubrepo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
bd6f4ee146 fix: authenticate weblate requests (#6790)
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
2021-07-25 15:53:41 +00:00
Pierre-Yves BandGitHub 5f9e8deafc Fix UptimeRobot status endpoint (#6757) 2021-07-11 14:17:26 +01:00
Pierre-Yves BandGitHub 30e46a69a7 Delete old deprecated badges (#6756) 2021-07-11 13:47:25 +01:00