actions/setup-opentofu
1
0
Fork 0
mirror of https://github.com/opentofu/setup-opentofu.git synced 2025-12-31 15:02:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: improves jsdoc.

Browse source 
Signed-off-by: Dmitry Kisler <admin@dkisler.com>
This commit is contained in:
Dmitry Kisler 2023-10-12 17:53:12 +02:00
parent 6196ddd9f5
commit 29bd5d3445
No known key found for this signature in database
GPG key ID: 46C0A987D58548F6
2 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
dist/index.js vendored
View file

@ -31,6 +31,7 @@ class Release {
/** /**
* Fetches the top 30 releases sorted in desc order. * Fetches the top 30 releases sorted in desc order.
* *
* @return {Array<Release>} Releases.
*/ */
async function fetchReleases () { async function fetchReleases () {
const url = 'https://api.github.com/repos/opentofu/opentofu/releases'; const url = 'https://api.github.com/repos/opentofu/opentofu/releases';
@ -66,6 +67,7 @@ async function findLatestVersionInRange (versions, range) {
* *
* @param {string} version: Release version. * @param {string} version: Release version.
* @param {function} fetchReleasesFn: Optional function to fetch releases. * @param {function} fetchReleasesFn: Optional function to fetch releases.
* @return {Release} Release.
*/ */
async function getRelease (version, fetchReleasesFn = fetchReleases) { async function getRelease (version, fetchReleasesFn = fetchReleases) {
const latestVersionLabel = 'latest'; const latestVersionLabel = 'latest';

2
lib/releases.js
View file

@ -25,6 +25,7 @@ class Release {
/** /**
* Fetches the top 30 releases sorted in desc order. * Fetches the top 30 releases sorted in desc order.
* *
* @return {Array<Release>} Releases.
*/ */
async function fetchReleases () { async function fetchReleases () {
const url = 'https://api.github.com/repos/opentofu/opentofu/releases'; const url = 'https://api.github.com/repos/opentofu/opentofu/releases';
@ -60,6 +61,7 @@ async function findLatestVersionInRange (versions, range) {
* *
* @param {string} version: Release version. * @param {string} version: Release version.
* @param {function} fetchReleasesFn: Optional function to fetch releases. * @param {function} fetchReleasesFn: Optional function to fetch releases.
* @return {Release} Release.
*/ */
async function getRelease (version, fetchReleasesFn = fetchReleases) { async function getRelease (version, fetchReleasesFn = fetchReleases) {
const latestVersionLabel = 'latest'; const latestVersionLabel = 'latest';