GitHub integration warning?
See original GitHub issueCreated a test repo codedoc having master
as its default branch and configure gh-pages to the gh-pages
branch. After which running:
# local system is archlinux
$codedoc init
populates config.ts
as:
// config.ts
import { configuration } from '@codedoc/core';
import { theme } from './theme';
export const config = /*#__PURE__*/configuration({
theme, // --> add the theme. modify `./theme.ts` for chaning the theme.
page: {
title: {
base: 'Codedoc' // --> the base title of your doc pages
}
},
});
$codedoc check # No issues detected
Since my repo is in github (and gh-pages are already configured) I thought config.ts
should have produced the github
literal. Did I miss something? So I manually added the github integration as:
// config.ts
import { configuration } from '@codedoc/core';
import { theme } from './theme';
export const config = /*#__PURE__*/configuration({
theme, // --> add the theme. modify `./theme.ts` for chaning the theme.
page: {
title: {
base: 'Codedoc' // --> the base title of your doc pages
}
},
dest: {
html: 'dist',
assets: 'dist',
namespace: '/codedoc'
},
misc: {
github: {
user: 'nakednous',
repo: 'codedoc',
action: 'Star',
count: false,
large: true,
standardIcon: false,
}
},
});
However, running codedoc check
produces the following warning:
$codedoc check
# Checking GitHub configuration ...
#
# WARNING::
# Your CODEDOC config indicates GitHub integration, but
# your project folder is not in sync with a GitHub repository.
#
# You can fix this by modifying .codedoc/config.ts
#
# Read https://codedoc.cc/docs/config/misc#github-integration for more information.
#
Is it an issue or is it just my config?
Issue Analytics
- State:
- Created 3 years ago
- Comments:6 (3 by maintainers)
Top Results From Across the Web
Managing code scanning alerts for your repository
On GitHub.com, navigate to the main page of the repository. · Under the repository name, click Security. · In the left sidebar, click...
Read more >Tracking code scanning alerts in issues using task lists
Code scanning alerts integrate with task lists in GitHub Issues to make it easy for you to prioritize and track alerts with all...
Read more >Triaging code scanning alerts in pull requests - GitHub Docs
You can see any code scanning alerts introduced in a pull request by viewing the Conversation tab. Code scanning posts a pull request...
Read more >About integration with code scanning - GitHub Docs
As an alternative to running code scanning within GitHub, you can perform analysis elsewhere and then upload the results. Alerts for code scanning...
Read more >shopifyignore being ignored by Github integration · Issue #1961
Whenever new changes are being pushed, the Shopify integration throws a warning saying that .shopifyignore was ignored
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I get:
https://github.com/nakednous/codedoc
So I just tried to replicate the issue doing the following:
And I get no warnings. Can you run this command in the cloned folder where you get the warning and reply the result?