question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Link to CHANGELOG.md on Releases page

See original GitHub issue
  1. Visit https://github.com/nodeca/js-yaml/releases
  2. See nothing useful
  3. Navigate to https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md because thats there the changelog is kept

We can send a HEAD request to $default/CHANGELOG.md and link to it if it exists when visiting a releases page, perhaps just if the page doesn’t have releases.

The unfortunate part is that the HTTP request is case-sensitive, so with this method we can only check and link to that specific but common format.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:5
  • Comments:16 (13 by maintainers)

github_iconTop GitHub Comments

2reactions
cheap-glitchcommented, Feb 1, 2021

Could we use the GraphQL Search API to find files case-insensitively?

I don’t think you can search for files or code using the GraphQL API (supported search types are only “ISSUE”, “USER” and “REPO”). But we could do something like this:

query { 
  repository(owner: "<owner>" name: "<name>") {
    lowercase: object(expression: "HEAD:changelog.md") {
      ...on Blob {
        oid
      }
    }
    uppercase: object(expression: "HEAD:CHANGELOG.md") {
      ...on Blob {
        oid
      }
    }
  }
}

or query all the top-level files and check if there’s a changelog among them:

query { 
  repository(owner: "<owner>" name: "<name>") {
    object(expression: "HEAD:") {
      ...on Tree {
        entries {
          name
        }
      }
    }
  }
}
0reactions
tooommcommented, Feb 22, 2021

This is normal, the changelog file of this repo is named CHANGES so it isn’t supported yet. That’s what the new, unreleased PR is about.

My bad, mixed it up with the linked new PR above my comment which has those examples linked. I randomly picked one of those.

It works now at pyca again after trying several times. Still not at nodeca. After trying like 5+ more times… it appears now at e.g. https://github.com/nodeca/js-yaml/releases, too. 🤷

After clearing the extension cache, the working one for pyca disappeared as well after refreshing the site.

I can’t reproduce this no matter how I try. Could this be an issue with your personal token? Did you enable all the scopes?

I’ve no personal token setup! How should I know - as a user - that I have to and which of the many features require it? Settings only tell me it’s optional. And the linked GitHub search is not really user friendly. A detailed search there reveals that link-to-changelog-file.tsx is listed though. Not intuitive at all to connect the dots here. That’s a different issue I guess.

No clue why it starts working after many tries - even with no token setup?!

Related messages in web console are:

Content Security Policy: The page's settings blocked the loading of a resource at data: ("media-src").
ℹ️ Refined GitHub → convert-release-to-draft → Personal token required for this feature index.tsx:54:10
ℹ️ Refined GitHub → bugs-tab → Personal token required for this feature index.tsx:54:10
ℹ️ Refined GitHub → repo-wide-file-finder → Personal token required for this feature index.tsx:54:10

Nothing mentioned about “link to changelog”.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Generate Changelog from GitHub Releases
changelog -from-release is a (too) small command line tool to generate changelog from GitHub Releases. It fetches releases of the repository via GitHub...
Read more >
Keep a Changelog
Links to latest released version in previous versions. ... Changed - Refer to a "change log" instead of a "CHANGELOG" throughout the site...
Read more >
Changelog entries - GitLab Docs
This guide contains instructions for when and how to generate a changelog entry file, as well as information and history about our changelog...
Read more >
How To Automatically Generate A Helpful Changelog From ...
Creating a changelog is a usual task if a new software version is going to be released. It contains all the changes which...
Read more >
Changelog - The GitHub Blog
We just finished releasing the last feature update of the year for Projects. ... include a link to relevant documentation provided by the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found