Git Product home page Git Product logo

plugin-enterprise-server.js's Introduction

plugin-enterprise-server.js

Octokit plugin for GitHub Enterprise Server REST APIs

@latest Build Status

@octokit/rest and the @octokit/plugin-rest-endpoint-methods plugin it's using internally do not include methods for Enterprise Administration as they do not exist on https://api.github.com. This plugin adds endpoint methods for every GitHub Enterprise Server version that is currently supported.

Besides the admin-specific endpoints, there are differences between api.github.com and each GitHub Enterprise Server version. Instead of loading @octokit/plugin-rest-endpoint-methods you can optionally add all endpoint methods for each GitHub Enterprise Server version, including the admin endpoints.

Usage

Browsers

Load @octokit/plugin-enterprise-server and @octokit/core (or core-compatible module) directly from esm.sh

<script type="module">
  import { Octokit } from "https://esm.sh/@octokit/core";
  import { enterpriseServer220Admin } from "https://esm.sh/@octokit/plugin-enterprise-server";
</script>
Node

Install with npm install @octokit/core @octokit/plugin-enterprise-server. Optionally replace @octokit/core with a core-compatible module

const { Octokit } = require("@octokit/core");
const {
  enterpriseServer36Admin,
} = require("@octokit/plugin-enterprise-server");
const OctokitEnterprise36 = Octokit.plugin(enterpriseServer36Admin);
const octokit = new OctokitEnterprise36({
  auth: "secret123",
  baseUrl: "https://github.acme-inc.com/api/v3",
});

octokit.enterpriseAdmin.createUser({
  username: "octocat",
  email: "[email protected]",
});

The list of currently exported plugins are

How it works

The route definitions for the currently supported GitHub Enterprise versions are built automatically from @octokit/openapi. Each time there is a new @octokit/openapi release, the .github/workflows/update.yml workflow is triggered. If an update is found, a pull request is created.

LICENSE

MIT

plugin-enterprise-server.js's People

Contributors

amenocal avatar dependabot[bot] avatar dominykas avatar eddman avatar github-actions[bot] avatar gr2m avatar greenkeeper[bot] avatar heroichitesh avatar kfcampbell avatar nickfloyd avatar octokitbot avatar oscard0m avatar renovate[bot] avatar rohit-chaudhary1 avatar timrogers avatar wolfy1339 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

plugin-enterprise-server.js's Issues

Question: How do I get list of organizations a user is associated to

Hey,
I'm using Github Enterprise and my use case is to get metrics using GitHub API. As part of this effort, I've a list of users to go against and fetch the necessary data for reporting and analysis.

I'm trying to get all the Organizations(public & private) each user belongs to and get all repositories within those organizations and get stats for each repository.

I tried using this method: octokit.orgs.listForUser({ username, per_page, page }); which results in only public orgs. Since it is enterprise GitHub server, all orgs are private and I'm unable user organizations.

Can you recommend/suggest if there is a way to fetch this data.

P.S: There seems to be an GitHub endpoint for this ask but this is only for an authenticated user.
https://developer.github.com/enterprise/2.20/v3/orgs/#list-your-organizations

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch master on the remote Git repository with URL https://x-access-token:[secure]@github.com/octokit/plugin-enterprise-server.js.git.

This can be caused by:


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: package.json
Error type: The renovate configuration file contains some invalid settings
Message: Configuration option 'packageRules[0].npm' should be a json object, Invalid configuration option: @pika/pack, Invalid configuration option: author, Invalid configuration option: jest, Invalid configuration option: keywords, Invalid configuration option: license, Invalid configuration option: name, Invalid configuration option: packageRules[0].@octokit/types, Invalid configuration option: packageRules[0].i, Invalid configuration option: packageRules[1].@octokit/core, Invalid configuration option: packageRules[2].@octokit/core, Invalid configuration option: packageRules[2].@octokit/graphql, Invalid configuration option: packageRules[2].@pika/pack, Invalid configuration option: packageRules[2].@pika/plugin-build-node, Invalid configuration option: packageRules[2].@pika/plugin-build-web, Invalid configuration option: packageRules[2].@pika/plugin-ts-standard-pkg, Invalid configuration option: packageRules[2].@types/fetch-mock, Invalid configuration option: packageRules[2].@types/jest, Invalid configuration option: packageRules[2].@types/node, Invalid configuration option: packageRules[2].fetch-mock, Invalid configuration option: packageRules[2].jest, Invalid configuration option: packageRules[2].npm-run-all, Invalid configuration option: packageRules[2].prettier, Invalid configuration option: packageRules[2].semantic-release, Invalid configuration option: packageRules[2].semantic-release-plugin-update-version-in-files, Invalid configuration option: packageRules[2].sort-keys, Invalid configuration option: packageRules[2].ts-jest, Invalid configuration option: packageRules[2].typescript, Invalid configuration option: publishConfig, Invalid configuration option: release, Invalid configuration option: renovate, Invalid configuration option: scripts, Invalid configuration option: version, The "npm" object can only be configured at the top level of a config but was found inside "packageRules[0]"

[BUG]: Missing endpoints for management of runner groups on the Repo and Org level

Replace "cdn.pika.dev" with "cdn.skypack.dev" in README

πŸ†•πŸ₯☝ First Timers Only.

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you πŸ’

About First Timers Only.

πŸ€” What you will need to know.

The Pika CDN is now Skypack, see https://www.pika.dev/cdn. The CDN at https://cdn.pika.dev/ no longer works, all URLs must be replaced with the new CDN: https://cdn.skypack.dev/. We currently recommend using cdn.pika.dev to import the library into the browser, but that no longer works. Replacing it with cdn.skypack.dev will make it work again.

πŸ“‹ Step by Step

  • πŸ™‹ Claim this issue: Comment below.

    More than one person can work on this issue, don't worry if it's already claimed.

  • πŸ“ Update the file \README.md (press the little pen Icon) and edit as shown below:

@@ -17,12 +17,12 @@ Besides the admin-specific endpoints, there are differences between `api.github.
 Browsers
 </th><td width=100%>
 
-Load `@octokit/plugin-enterprise-server` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.pika.dev](https://cdn.pika.dev)
+Load `@octokit/plugin-enterprise-server` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.skypack.dev](https://cdn.skypack.dev)
 
 ```html
 <script type="module">
-  import { Octokit } from "https://cdn.pika.dev/@octokit/core";
-  import { enterpriseServer220Admin } from "https://cdn.pika.dev/@octokit/plugin-enterprise-server";
+  import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
+  import { enterpriseServer220Admin } from "https://cdn.skypack.dev/@octokit/plugin-enterprise-server";
 </script>
 ```
 
  • πŸ’Ύ Commit your changes

  • πŸ”€ Start a Pull Request. There are two ways how you can start a pull request:

    1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.
    2. You can edit files directly in your browser
  • 🏁 Done Ask for a review :)

If there are more than one pull requests with the correct change, we will merge the first one, but attribute the change to all authors who made the same change using @Co-authored-by, so yo can be sure your contribution will count.

πŸ€”β“ Questions

Leave a comment below!

This issue was created by First-Timers-Bot.

404 Malformed URL

While trying to call get Orgs endpoint as per the documentation, internally it's not forming right url.

This is the URL that being called internally : https://github.companyurl.com/api/v3orgname when I execute the below code. Please advise.

const { Octokit } = require("@octokit/core");
const {
  enterpriseServer219
} = require("@octokit/plugin-enterprise-server");


const OctokitEnterprise = Octokit.plugin(enterpriseServer219);
const octokit = new OctokitEnterprise({
  auth: "secret123",
  baseUrl: "https://github.companyurl.com/api/v3"
});

octokit.orgs.get("orgname").then(function(response){
 console.log(response)
}, (error) => {
  console.log(error);
});

Dependency Dashboard

This issue contains a list of Renovate updates and their statuses.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to ignore the schedule.

  • fix(deps): lock file maintenance

  • Check this box to trigger a request for Renovate to run again on this repository

An in-range update of semantic-release is breaking the build 🚨

The devDependency semantic-release was updated from 15.13.20 to 15.13.21.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

Release Notes for v15.13.21

15.13.21 (2019-08-12)

Bug Fixes

  • package: update hosted-git-info to version 3.0.0 (391af98)
Commits

The new version differs by 3 commits.

  • 391af98 fix(package): update hosted-git-info to version 3.0.0
  • d45d8b6 docs: fix typo
  • 519df0d chore: remove commitizen from our dependencies

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Add GHE 3.1 and 3.2 endpoints

There are already GHE 3.1 and 3.2, but this plugin contains only 3.0.

Please add missing GHE versions.

Note:

I tried to open a PR instead, but failed to do so. The code in this repo is not executable; I've set VERSION to 5.2.2, even removed deprecated versions 220 and 221 from ghe-versions.js, but it is still failing on /app/hook/config for GHE 2.22:

Cannot read property 'deprecationDate' of undefined

at

    deprecationDate: definition["x-github"].deprecationDate,

Is there any trick to run it?

Add @octokit/core as peerDependency

This is a follow up issue to octokit/plugin-paginate-rest.js#124 (comment)

We need to add @octokit/core as a peerDependency to address a problem with yarn 2. It is something I planned to do anyway, but wanted to figure out automated testing to assure compatibility of the plugins with the latest @octokit/core.

I only want to define compatibility with the lowest version, in this case v3. Compare pull request https://github.com/octokit/plugin-paginate-rest.js/pull/130/files.

I would appreciate help, this is a great issue for a first-time contributor

Question: Is there an easier way to navigate trough pages?

I see that pagination information is coming in the headers but, do we have an API method that was built to easily navigate through pages or get all pages info in one call?

also, any pointers to documentation to understand the API better.?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.