I want to display the contents of a CHANGELOG.md file (which is included in the nuget package I publish) in the PR created by Dependabot.
Example of such behavior for FluentValidation package:
I can't figure out how to do that. Additionally, I have noticed that even for the same 'FluentValidation` package, another PR was missing the changelog:
I have not found any documentation on this topic.
Related
I built a docker image and published it to github package registry under an organization and linked it to a specific repository. However, I would like to specify a different README file to be displayed in the package registry under the image I published.
Currently, the README that is displayed is the general one for my repository. Is there a way to change/specify which one is displayed for my package?
No, that's currently not possible. When a repository is linked to the package, it will show the repository's readme. When you navigate to a specific version of the package, it will show that version's readme.
I recently created an extension and I am trying to set up a workflow to automatically publish the extension to the VSCode marketplace when I see fit.
I have read the official article which only shows fractions of the final set up and which also seems a little outdated. Following that and copying from misc. repos on Github, I have patched together a semi-working solution. Yet, the workflow is really odd.
It seems like the tutorial is suggesting you try to run a vsce publish when a new tag has been pushed or a release has been created/published. But here is what that looks like:
Make a commit(s) with new code/features you want to add to the extension.
Change package.json manually to update the version number.
Tag the commit manually with the same version number.
Push commit and tag.
(make a release manually on Github to have consistency between tags and published extension version and to trigger eventual action)
Github action is executed and hopefully succeeds, otherwise you will have to redo a bunch of above steps.
The above workflow is not optimal as it requires you to enter the version number about 3-4 times. This can be improved somewhat.
Make a commit(s) with new code/features you want to add to the extension.
Run vsce package <version> to create a new commit with a new tag and also update package.json in one command.
Push commit and tag.
(make a release manually on Github to have consistency between tags and published extension version)
Github action executed vsce publish which almost certain to succeed since vsce package <version> already succeeded previously.
This scenario is better but still has some problems:
The Github Action will need to listen to a new tag push.
Could it also create a release automatically?
Is it common practice to always create a Github release from a tag?
Step 2 requires you to build the project to a .vsix file.
Can this be prevented?
We could instead do this on Github through and action. But what would we listen to to trigger this action? We need a version number, but it can not come from a tag since vsce package <version> creates a new tag and updated the pacakge.json for us.
What is the optimal workflow to make this process as painless as possible?
Hello I have published a library in my GitHub repository and i want to use the used by button in the repository
I checked the repository settings but found no options to enable it
How do I enable this button in my repository?
netlify/staticgen issue 507 also asks, as you do:
GitHub introduced a new metric, which I find much more relevant than stars or downloads. It shows the number of times a dependency is used by other repositories.
How is this metric added to a repository?
GitHub shows package metrics for projects that use a package manager, eg. if your repo has a package.json, it will use that to show your dependency network.
It is then automatically analyzed by GitHub, which scan other repository where your project reference shows up.
This was announced last May 2019 by GitHub.
And it can be misleading (for monorepos)
Official documentation: "Listing the projects that depend on a repository"
This is only for projects using:
RubyGems
NPM
PyPI
Maven (pom.xml only)
Nuget
Check the supported languages.
In a github repository I own most of the dependencies are rendered as links - but some of them, including one of my own Github repository dependencies (aor-component-factory), don't.
Is it because they are not that popular and they weren't indexed yet or there is some configuration/code that needs to be added to those repositories? Thanks!
One possible reason is for repo renamed (the OP confirms it wasn't).
Another reason is the path used to reference dependencies in the package.json
zifnab87/ra-component-factory
vs.
ra-component-factory
The former should work better.
Following this tweet, try and apply to your repo the jgamblin/GithubDependencyCheck tools to see if that particular dependency in gray is reported any differently.
From the OP Michail Michailidis's comment, it seems that was a GitHub bug that was since fixed (Dec. 2017).
I'm editing one of my open-source projects on GitHub and I want to replace link (pointing to a demo) in README.md.
Do I have to update library version every time I introduce some minor changes to the README file or documentation (without any actual code changes)?
What is the community accepted practice?
If it's important, I'm using Bower to distribute my package and SemVer as a versioning system.
The README file is part of your codebase. It should describe the current (= in current commit) state of the code. A developer might read it outside GitHub's environment, e.g. from the node_modules directory on their hard drive, expecting it is up to date.
Therefore I would recommend to release a new version when the README changes.
It will usually result in just a patch number increase. But remember that when marking something as deprecated one must release a new minor version (paragraph 7 in SemVer v2.0.0).
If you plan to do really a lot of changes there are two ways to avoid releasing too often:
Make changes in a branch. Merge to master here and there, release a new patch version.
Move the documentation (or a part of it) somewhere else. GitHub Wiki or a simple webpage, e.g. using GitHub Pages, could come in handy.
You could include, as library version, the content of of git describe --all --long, as described in How can I get the Git build number and embed it in a file? (using git describe).
That way, you get the latest tag, plus the number of (small) commits you did since that tag.
That means:
you don't have to put a new tag if you don't want to
but you still keep an exact reference the the version of your repo which was used for delivering your app.