I have an open-source repo on GitHub called Gamgee. (It's a dinky little music queue bot built on Node.js, in case you're curious.) It's been around for not much more than a week and doesn't export anything useful as a package, yet GitHub already reports that this repo is "used by" another repository of the same name.
The referenced package is very small and doesn't seem to list any dependencies at its root package.json other than TypeScript. Is this a GitHub bug, or am I missing something here? If this is a GitHub bug, where might I report those?
Related
I keep finding piecemeal examples of things that can go into a .github directory on a GitHub repository.
I can see that it is used for GitHub actions and workflow and for Pull request and issue templates, but I can't see a page outlining what you can put in there with ideally some documentation. I also think I've seen a funding example too.
Basically every time I see something you can do there, I think "that's neat I should do that", but other than examples I can't see a way to discover new things other than by example.
Due to the fact that the directory is called .github it seems to defy Google and SO search as well.
On Github, folder .github is just a convention folder used to place Github related stuff inside it. Github handles some of these files even when you place it in root of your project (such as CONTRIBUTING.md, CODE_OF_CONDUCT.md etc). Because Github is constantly bringing in new features, these features are documented on their own, so there is no "all possible files in .github" page. Feel free to place anything that is related to Github specifically inside it.
Some of the most used files in .github folder:
CODE_OF_CONDUCT.md -> How to engage in community and how to behave yourself.
CONTRIBUTING.md -> How to contribute to repo (making pull request, setting development environment...)
LICENSE.md - A software license tells others what they can and can't do with your source code (You should place this at the root of your project since GitHub ignores it in .github folder. You can find this file while browsing other Git hosting services such as GitLab, Bitbucket etc.)
FUNDING.yml -> Supporting a project
ISSUE_TEMPLATE -> Folder that contains a templates of possible issues user can use to open issue (such as if issue is related to documentation, if it's a bug, if user wants new feature etc) P.S. Take a look at tensorflow ISSUE_TEMPLATE
PULL_REQUEST_TEMPLATE.md -> How to make a pull request to project
stale.yml -> Probot configuration to close stale issues. There are many other apps on Github Marketplace that place their configurations inside .github folder because they are related to GitHub specifically.
SECURITY.md -> How to responsibly report a security vulnerability in project
workflows -> Configuration folder containing yaml files for GitHub Actions
CODEOWNERS -> Pull request reviewer rules. More info here.
dependabot.yml -> Configuration options for dependency updates. More info here.
You don't have to create all these files immediately. If there are lot of bugs reported in your project, create ISSUE_TEMPLATE. If several people wants to support you, create FUNDING.yml . You will create more and more files when the need comes.
Github lists all of the files you can use in the documentation page titled Creating a default community health file and the workflows you can add to the .github directory are detailed in the Introduction to GitHub Actions documentation.
I know this question sounds dumb, but I am unable to understand the difference between the main project and project option provided inside each repository.
Are they same? (But the URL differs)
I looked at help.github.com
but it doesn't help.
I basically understand that for larger projects management, project inside repository is helpful.
on what uses cases, they provided the another project outside of repository and linking those repositories to it?
Is that for structuring?
There is a repository on github (sometimes called a "project") where you store your code. You change the code, make a git commit, and push those code changes to the github repository.
GitHub also has a feature called "projects" which provides you a method for managing the work that needs to be done on the code. GitHub also has "issues", an issue tracker. You can use the GitHub Project Board to organize your GitHub issues, giving you a way to see see where things are at in your effort on the code.
You can turn off the "projects" and "issues" features in the repository settings, you don't have to use them. The center of work is the code in the repository, which might be referred to as a project -- the Projects feature lets you manage your issues in GitHub in a more visual format.
The difference is in the scope. The "main project" (user-owned project board) can have issues and pull requests from multiple repositories whereas the "project in repository" (repository project board) can contain only the issues and pull requests belonging to that repository.
From the Project boards docs:
Types of project boards:
User-owned project boards can contain issues and pull requests from any personal repository.
Organization-wide project boards can contain issues and pull requests from any repository that belongs to an organization. You can link up to twenty-five repositories to your organization or user-owned project board...
Repository project boards are scoped to issues and pull requests within a single repository. They can also include notes that reference issues and pull requests in other repositories.
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.
Following page page points to Github's page where pre-build binaries are contained. If I have not found first mentioned page first then I would have not an idea that such page (with pre-build binaries) exists on Github. Is it usual to put some pre-build binaries under releases on GitHub (I've seen it also other times e.g. with gns3)? Is there any link on project's Github page which will point me to releases (maybe I can add releases to corresponding URL but I guess there must be some link which points to it)
The "release" pages is available on any GitHub project. You can access it quickly using the link on top of project (between branches and contributors):
GitHub release page is computed from Git repository tags. The maintainer of the project is free to use it or not, but it's a common practice to transform a git tag into a release, attaching a description (changelog, release note, etc) and/or some files (pre-build packages, setups, DMGs, etc.)
GitHub team wrote a blog post a few years ago to explain this feature.
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).