Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links to docs to link to new grafana docs #117

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Conversation

mstoykov
Copy link
Contributor

Description

Update links to link to new docs

Please fill in this template.

  • Use a meaningful title for the Pull Request. Include the name of the jslib added/modified.
  • Fill the description section of the Pull Request.
  • Test the change in your code, and ensure the npm run test command succeeds.
  • Run yarn run generate-homepage locally and verify the new homepage /lib/index.html file looks legit.

Select one of these and delete the others:

If adding a new jslib:

  • The Pull Request creates a /lib/{jslib_name} folder.
  • The Pull Request creates a /lib/{jslib_name}/{desired_version} folder.
  • The /lib/{jslib_name}/{desired_version}/index.js file containing the jslib's code bundle exists.
  • The Pull Request updates the supported.json file to contain an entry for the newly added jslib and its {desired_version}, as in the following example:
{
  "{jslib_name}": {
    // Available package versions
    "versions": [
      "{desired_version}"
    ],

    // (optional) Documentation's or repository's URL
    "docs-url": "{documentation_or_repository_url}",

    // (optional) As a default, the homepage will point to
    // a package's bundle's index.js. If your package's main
    // bundle name is different; set it here (see the AWS
    // package for instance).
    "bundle-filename": "{index.js}"
}
  • Tests have been added to /tests/basic.js and /tests/testSuite.js to ensure that the added jslib is importable and runnable by k6.

If publishing a new version of an existing jslib:

  • The Pull Request is labeled with the version bump label.
  • The Pull Request adds a /lib/{jslib_name}/{desired_version} folder.
  • The Pull Request adds a /lib/{jslib_name}/{desired_version}/index.js file containing the jslib's code bundle.
  • The Pull Request updates the supported.json file to contain an entry for the newly added jslib version, as in the following example:
{
  "my-lib": [
    "1.0.2",
    // Use semantic versioning
    "{desired_version}"
  ]
}
  • The Pull Request adds the relevant tests to the /tests/basic.js and /tests/testSuite.js files to ensure that the new version of the jslib is importable and runnable by k6.
  • Merge the Pull Request once it is green. PRs adding new jslib versions do not require to get a review to be merged 🚀.

@mstoykov mstoykov requested review from a team as code owners April 15, 2024 10:50
@mstoykov mstoykov requested review from oleiade, joanlopez, 2Steaks and EdvinasDaugirdas and removed request for a team April 15, 2024 10:50
@@ -29,7 +29,7 @@
},
"httpx": {
"versions": ["0.0.1", "0.0.2", "0.0.3", "0.0.4", "0.0.5", "0.0.6", "0.1.0"],
"docs-url": "https://k6.io/docs/javascript-api/jslib/httpx"
"docs-url": "https://grafana.com/docs/k6/latest/javascript-api/jslib/httpx"
},
"expect": {
"versions": ["0.0.4", "0.0.5"],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This librarary has a lin, but it actually just redirects to k6chjaijs docs. I guess it is the expect library from there ... extracted?

But this redirect isn't happening in the new docs and ... ot be honest is not very obvious that this is what it is to begin with.

I also didn't change k6chaijs to link to it's docs - it still links to its github, which I take it is on purpose?

cc @sniku @oleiade as the last people touching this.

Copy link
Contributor

@2Steaks 2Steaks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@mstoykov mstoykov merged commit 40c98d1 into main Apr 30, 2024
4 checks passed
@mstoykov mstoykov deleted the updateDocsLinks branch April 30, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants