151 lines
8.5 KiB
HTML
151 lines
8.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: services/osslifecycle/osslifecycle.service.js</title>
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Source: services/osslifecycle/osslifecycle.service.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>'use strict'
|
|
|
|
const { BaseService, InvalidResponse } = require('..')
|
|
|
|
const documentation = `
|
|
<p>
|
|
OSS Lifecycle is an initiative started by Netflix to classify open-source projects into lifecycles
|
|
and clearly identify which projects are active and which ones are retired. To enable this badge,
|
|
simply create an OSSMETADATA tagging file at the root of your GitHub repository containing a
|
|
single line similar to the following: <code>osslifecycle=active</code>. Other suggested values are
|
|
<code>osslifecycle=maintenance</code> and <code>osslifecycle=archived</code>. A working example
|
|
can be viewed on the <a href="https://github.com/Netflix/osstracker">OSS Tracker repository</a>.
|
|
</p>
|
|
`
|
|
|
|
module.exports = class OssTracker extends BaseService {
|
|
static category = 'other'
|
|
|
|
static route = {
|
|
base: 'osslifecycle',
|
|
pattern: ':user/:repo/:branch*',
|
|
}
|
|
|
|
static examples = [
|
|
{
|
|
title: 'OSS Lifecycle',
|
|
pattern: ':user/:repo',
|
|
namedParams: { user: 'Teevity', repo: 'ice' },
|
|
staticPreview: this.render({ status: 'active' }),
|
|
keywords: ['Netflix'],
|
|
documentation,
|
|
},
|
|
{
|
|
title: 'OSS Lifecycle (branch)',
|
|
pattern: ':user/:repo/:branch',
|
|
namedParams: {
|
|
user: 'Netflix',
|
|
repo: 'osstracker',
|
|
branch: 'documentation',
|
|
},
|
|
staticPreview: this.render({ status: 'active' }),
|
|
keywords: ['Netflix'],
|
|
documentation,
|
|
},
|
|
]
|
|
|
|
static defaultBadgeData = { label: 'oss lifecycle' }
|
|
|
|
/**
|
|
* Return color for active, maintenance and archived statuses, which were the three
|
|
* example keywords used in Netflix's open-source meetup.
|
|
* See https://slideshare.net/aspyker/netflix-open-source-meetup-season-4-episode-1
|
|
* Other keywords are possible, but will appear in grey.
|
|
*
|
|
* @param {object} attrs Refer to individual attrs
|
|
* @param {string} attrs.status Specifies the current maintenance status
|
|
* @returns {string} color
|
|
*/
|
|
static getColor({ status }) {
|
|
if (status === 'active') {
|
|
return 'brightgreen'
|
|
} else if (status === 'maintenance') {
|
|
return 'yellow'
|
|
} else if (status === 'archived') {
|
|
return 'red'
|
|
}
|
|
return 'lightgrey'
|
|
}
|
|
|
|
static render({ status }) {
|
|
const color = this.getColor({ status })
|
|
return {
|
|
message: status,
|
|
color,
|
|
}
|
|
}
|
|
|
|
async fetch({ user, repo, branch }) {
|
|
return this._request({
|
|
url: `https://raw.githubusercontent.com/${user}/${repo}/${branch}/OSSMETADATA`,
|
|
})
|
|
}
|
|
|
|
async handle({ user, repo, branch }) {
|
|
const { buffer } = await this.fetch({
|
|
user,
|
|
repo,
|
|
branch: branch || 'HEAD',
|
|
})
|
|
try {
|
|
const status = buffer.match(/osslifecycle=([a-z]+)/im)[1]
|
|
return this.constructor.render({ status })
|
|
} catch (e) {
|
|
throw new InvalidResponse({
|
|
prettyMessage: 'metadata in unexpected format',
|
|
})
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-badge-maker.html">badge-maker</a></li><li><a href="module-core_base-service_base.html">core/base-service/base</a></li><li><a href="module-core_base-service_base-graphql.html">core/base-service/base-graphql</a></li><li><a href="module-core_base-service_base-json.html">core/base-service/base-json</a></li><li><a href="module-core_base-service_base-svg-scraping.html">core/base-service/base-svg-scraping</a></li><li><a href="module-core_base-service_base-xml.html">core/base-service/base-xml</a></li><li><a href="module-core_base-service_base-yaml.html">core/base-service/base-yaml</a></li><li><a href="module-core_base-service_errors.html">core/base-service/errors</a></li><li><a href="module-core_base-service_graphql.html">core/base-service/graphql</a></li><li><a href="module-core_server_server.html">core/server/server</a></li><li><a href="module-core_service-test-runner_create-service-tester.html">core/service-test-runner/create-service-tester</a></li><li><a href="module-core_service-test-runner_icedfrisby-shields.html">core/service-test-runner/icedfrisby-shields</a></li><li><a href="module-core_service-test-runner_infer-pull-request.html">core/service-test-runner/infer-pull-request</a></li><li><a href="module-core_service-test-runner_runner.html">core/service-test-runner/runner</a></li><li><a href="module-core_service-test-runner_service-tester.html">core/service-test-runner/service-tester</a></li><li><a href="module-core_service-test-runner_services-for-title.html">core/service-test-runner/services-for-title</a></li><li><a href="module-core_token-pooling_token-pool.html">core/token-pooling/token-pool</a></li><li><a href="module-services_dynamic_json-path.html">services/dynamic/json-path</a></li><li><a href="module-services_steam_steam-base.html">services/steam/steam-base</a></li></ul><h3>Classes</h3><ul><li><a href="module.exports.html">exports</a></li><li><a href="module-core_base-service_base-graphql-BaseGraphqlService.html">BaseGraphqlService</a></li><li><a href="module-core_base-service_base-json-BaseJsonService.html">BaseJsonService</a></li><li><a href="module-core_base-service_base-svg-scraping-BaseSvgScrapingService.html">BaseSvgScrapingService</a></li><li><a href="module-core_base-service_base-xml-BaseXmlService.html">BaseXmlService</a></li><li><a href="module-core_base-service_base-yaml-BaseYamlService.html">BaseYamlService</a></li><li><a href="module-core_base-service_base-BaseService.html">BaseService</a></li><li><a href="module-core_base-service_errors-Deprecated.html">Deprecated</a></li><li><a href="module-core_base-service_errors-ImproperlyConfigured.html">ImproperlyConfigured</a></li><li><a href="module-core_base-service_errors-Inaccessible.html">Inaccessible</a></li><li><a href="module-core_base-service_errors-InvalidParameter.html">InvalidParameter</a></li><li><a href="module-core_base-service_errors-InvalidResponse.html">InvalidResponse</a></li><li><a href="module-core_base-service_errors-NotFound.html">NotFound</a></li><li><a href="module-core_base-service_errors-ShieldsRuntimeError.html">ShieldsRuntimeError</a></li><li><a href="module-core_server_server-Server.html">Server</a></li><li><a href="module-core_service-test-runner_runner-Runner.html">Runner</a></li><li><a href="module-core_service-test-runner_service-tester-ServiceTester.html">ServiceTester</a></li><li><a href="module-core_token-pooling_token-pool-Token.html">Token</a></li><li><a href="module-core_token-pooling_token-pool-TokenPool.html">TokenPool</a></li><li><a href="module-services_steam_steam-base-BaseSteamAPI.html">BaseSteamAPI</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-TUTORIAL.html">TUTORIAL</a></li><li><a href="tutorial-badge-urls.html">badge-urls</a></li><li><a href="tutorial-code-walkthrough.html">code-walkthrough</a></li><li><a href="tutorial-deprecating-badges.html">deprecating-badges</a></li><li><a href="tutorial-input-validation.html">input-validation</a></li><li><a href="tutorial-json-format.html">json-format</a></li><li><a href="tutorial-logos.html">logos</a></li><li><a href="tutorial-performance-testing.html">performance-testing</a></li><li><a href="tutorial-production-hosting.html">production-hosting</a></li><li><a href="tutorial-releases.html">releases</a></li><li><a href="tutorial-self-hosting.html">self-hosting</a></li><li><a href="tutorial-server-secrets.html">server-secrets</a></li><li><a href="tutorial-service-tests.html">service-tests</a></li></ul><h3>Global</h3><ul><li><a href="global.html#validateAffiliations">validateAffiliations</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sun May 02 2021 20:29:16 GMT+0000 (Coordinated Universal Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|